Sign in
Catalog

Get Catalog Entry

Retrieve a single catalog entry by api_id.

get/catalog/{api_id}

Path parameters

api_idstring required

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

Changed in 4 of the 85 revisions of this API.13639

  • 662bbfb3ad231See the full diff
    • ○

      added the optional property update_available to the response with the 200 status

      response-optional-property-added

  • d65fcba0d25a226See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • ○

      api operation id get_catalog_entry_catalog__api_id__get removed and replaced with getCatalogEntry

      api-operation-id-removed

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security AgentOauthAccessToken was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security JenticApiKey was removed from the API

      api-security-removed

    • ○

      api tag Catalog added

      api-tag-added

    • ○

      api tag catalog removed

      api-tag-removed

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 422

      response-media-type-name-specialized

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property code to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property instance to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property title to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property type to the response with the 422 status

      response-optional-property-added

    • ○

      the response property detail became required for the status 422

      response-property-became-required

    • ○

      added the required property _links to the response with the 200 status

      response-required-property-added

    • ○

      added the required property api_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property path to the response with the 200 status

      response-required-property-added

    • ○

      added the required property registered to the response with the 200 status

      response-required-property-added

    • ○

      added the required property spec_url to the response with the 200 status

      response-required-property-added

    • ○

      added the required property vendor to the response with the 200 status

      response-required-property-added

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5a765d68c56f1See the full diff
    • ○

      the endpoint scheme security AgentOauthAccessToken was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76e8f606372811611See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      media type application/problem+json was changed to a more general media type application/json for the response status 422

      response-media-type-name-generalized

    • ▲

      the response property detail became optional for the status 422

      response-property-became-optional

    • ▲

      the detail response property's maxLength was unset from 4096 for the response status 422

      response-property-max-length-unset

    • ▲

      the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • ▲

      removed the required property _links from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property api_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property path from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property registered from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property spec_url from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property vendor from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property code from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property instance from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property title from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 422 status

      response-optional-property-removed

    • ○

      api operation id getCatalogEntry removed and replaced with get_catalog_entry_catalog__api_id__get

      api-operation-id-removed

    • ○

      the endpoint scheme security HumanLogin was added to the API

      api-security-added

    • ○

      the endpoint scheme security JenticApiKey was added to the API

      api-security-added

    • ○

      the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    • ○

      api tag catalog added

      api-tag-added

    • ○

      api tag Catalog removed

      api-tag-removed

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog