Sign in
Catalog

List Catalog

List a keyset page of browsable catalog entries (search/filter aware).

The catalog holds thousands of entries, so this is cursor-paginated like GET /apis: follow next_cursor until has_more is false. catalog_total/registered_count/outdated_count count the whole manifest, not the page, so the Discover status row stays stable while scrolling.

get/catalog

Query parameters

qstring nullable
registered_onlyboolean
unregistered_onlyboolean
outdated_onlyboolean
include_snoozedboolean
cursorstring nullable
limitinteger

Response

Successful Response

catalog_totalinteger required

Total entries in the whole manifest (pre-filter, pre-page).

has_moreboolean

Whether another page follows.

manifest_age_secondsinteger nullable

Age of the cached manifest in seconds, or null when the cache is empty.

next_cursorstring nullable

Opaque keyset cursor for the next page (null when done).

outdated_countinteger

Count of whole-manifest registered entries with an upstream update available.

registered_countinteger required

Count of whole-manifest entries already imported locally.

Example response

{
  "catalog_total": 5231,
  "data": [],
  "has_more": true,
  "manifest_age_seconds": 3600,
  "next_cursor": "eyJpZCI6ICJzdHJpcGUuY29tIn0=",
  "registered_count": 12
}

Changes

Changed in 5 of the 85 revisions of this API.111044

  • a917fe7f00261See the full diff
    • ○

      added the new optional query request parameter include_snoozed

      new-optional-request-parameter

  • 662bbfb3ad233See the full diff
    • ○

      added the new optional query request parameter outdated_only

      new-optional-request-parameter

    • ○

      added the optional property data/items/update_available to the response with the 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • d65fcba0d25a327See the full diff
    • ▲

      for the query request parameter limit, the max was decreased from 500.00 to 200.00

      request-parameter-max-decreased

    • ▲

      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 list_catalog_catalog_get removed and replaced with listCatalog

      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

    • ○

      added the new optional query request parameter cursor

      new-optional-request-parameter

    • ○

      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 has_more to the response with the 200 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 manifest_age_seconds to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property next_cursor to the response with the 200 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 catalog_total to the response with the 200 status

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

      added the required property registered_count 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

  • 76e8f606372881012See 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 catalog_total from the response with the 200 status

      response-required-property-removed

    • ▲

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

      response-required-property-removed

    • ▲

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

      response-required-property-removed

    • ●

      deleted the query request parameter cursor

      request-parameter-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 has_more from the response with the 200 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 manifest_age_seconds from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property next_cursor from the response with the 200 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 listCatalog removed and replaced with list_catalog_catalog_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

    • ○

      for the query request parameter limit, the max was increased from 200.00 to 500.00

      request-parameter-max-increased

    • ○

      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