Catalog

Get Catalog Entry

Changed on

Retrieve a single catalog entry by api_id.

get/catalog/{api_id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /catalog/{api_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Path parameters

api_idstring required

Catalog identity of the API (domain[/sub-api]); send any / unencoded.

Example:stripe.com

Response

Successful Response

api_idstring required

Catalog identity of the API (manifest domain, e.g. stripe.com).

pathstring nullable required

Manifest path of the entry within the public-APIs repo.

registeredboolean required

Whether this entry is already imported locally — its spec_url backs a non-archived revision in GET /apis.

spec_urlstring nullable required

Fetchable OpenAPI spec URL the entry resolves to (used for import + coverage).

update_availableboolean

Whether this (registered) entry has an upstream spec update the local revision hasn't adopted yet. Always false for unregistered entries.

vendorstring nullable required

Registrable-domain vendor derived from api_id (e.g. stripe.com).

Example response

{
  "_links": {
    "import": "/catalog/stripe.com:import",
    "operations": "/catalog/stripe.com/operations",
    "self": "/catalog/stripe.com"
  },
  "api_id": "stripe.com",
  "path": "apis/openapi/stripe.com",
  "registered": false,
  "spec_url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/main/apis/openapi/stripe.com/main/2024-01-01/openapi.json",
  "vendor": "stripe.com"
}

Changes