Skip to main content

Get Catalog App

GET /catalog-apps/{catalog_app_id}

Returns the full CatalogApp object for a single catalog app. Use this endpoint to load a catalog app detail page, or to resolve a catalog app reference from another domain (e.g. from a client app record).

When to use Get Catalog App vs List Catalog Apps

Use caseEndpoint
Load a catalog app detail page by IDGET /catalog-apps/{id}
Resolve a catalog app link from another domainGET /catalog-apps/{id}
Browse the full application catalogGET /catalog-apps
Search catalog apps by nameGET /catalog-apps?q=
Filter by vendor or categoryGET /catalog-apps?vendor_id= or ?category_id=

Path Parameters

ParameterTypeDescription
catalog_app_idstring (uuid)Unique identifier for the catalog app

Response

Returns a single CatalogApp object.

Example Request

curl -X GET "https://api.example.com/v2/catalog-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"canonical_name": "Google Chrome",
"description": "A cross-platform web browser developed by Google",
"display_colour": "#4285F4",
"logo": "https://cdn.example.com/logos/chrome.png",
"type": "browser",
"vendor": {
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Google LLC",
"url": "https://about.google"
},
"categories": [
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Productivity"
},
{
"id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"name": "Browser"
}
],
"created_at": "2025-06-15T10:00:00.000Z",
"updated_at": "2026-01-20T14:30:00.000Z"
}

Error Responses

StatusDescription
401Authentication required
403Insufficient permissions
404Catalog app not found
500Server error

Example Error Response

{
"error": {
"code": "not_found",
"message": "Catalog app not found",
"details": {
"catalog_app_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
}