Skip to content

The applications anyone may reuse

OpenAPI JSON
GET
/v1/catalog
curl --request GET \
--url https://api.eu.apigami.com/v1/catalog

Every published application, with its identifier, its slug, what it does and the actions it exposes. Public on purpose: choosing between two of them is the point, and a catalogue you have to sign in to read cannot be compared. An application reaches another team only once the version it publishes has been reviewed, and each entry says whether that is the case.

q
string
<= 120 characters

Words to match in the name or the public name.

limit
integer
>= 1 <= 100
offset
integer

The page asked for. next is null on the last one.

Media typeapplication/json
object
applications
required
Array<object>
object
app_id
required

What code written against this application uses. A public name can be changed; this cannot.

string format: uuid
slug
required

Unique on all of Apigami; it names the application’s host, {slug}.apigami.tech.

string
group

The slug of its team, when the team has one.

string | null
name
required

The application’s own name, fixed outside any version; it does not change when a version is published.

string
title

The info.title of the version in production, so it changes at every publication.

string
description
string | null
version_id
string format: uuid
version

The version its author declared, info.version of the manifest. version_id identifies the row; this is what the author wrote.

string | null
visibility
string
Allowed values: unlisted public
reviewed
boolean
callable_by_other_groups

False until Apigami has reviewed the version in production.

boolean
published_at
string | null format: date-time
actions
required
Array<object>
object
action
required

Its operationId, which is the name you call.

string
summary
string | null
description
string | null
method
required
string
path
required
string
next
required
object
offset
integer
Example
{
"applications": [
{
"visibility": "unlisted"
}
]
}