entryIdstringrequired
Identifier of the catalog entry.
Example:entry_4d9b2e
Withdraw a catalog entry
Takes a catalog entry off every channel and marks it withdrawn.
The record remains available for audit purposes.
post
Path Parameters
Response
Response
Withdrawn
post/catalog-entries/{entryId}/withdraw
Authentication
Path Parameters
Download the catalog entry record
Returns the generated document. Only available once status is
completed - before that the API responds with 409.
get
Path Parameters
entryIdstringrequired
Identifier of the catalog entry.
Example:entry_4d9b2e
Response
application/pdf
Response
application/pdf
PDF document
string
get/catalog-entries/{entryId}/record
Authentication
Path Parameters
application/pdf
Publish a catalog entry
Puts the catalog entry live on the chosen channels. Compliance
disclosures are checked first.
post
Path Parameters
entryIdstringrequired
Identifier of the catalog entry.
Example:entry_4d9b2e
Body
application/json
Body
application/json
channelsarray[string]required
Publication channel.
Allowed values:internal_catalogslack_directoryservice_now_cmdbapi_directory
>= 1 items
scheduled_forstring(date-time)
Optional time for a later, scheduled publication.
Response
application/json
Response
application/json
Published, or scheduled
Publication
entry_idstring
Example:entry_4d9b2e
statusstring
Lifecycle of a catalog entry.
Allowed values:in_progresscompletedpublishedwithdrawnfailed
Example:completed
channelsarray[object]
Show Child Parameters
published_atstring(date-time)
Example:2026-08-20T09:44:03Z
post/catalog-entries/{entryId}/publish
Authentication
Path Parameters
Body
{
"channels": [
"internal_catalog",
"slack_directory",
"service_now_cmdb"
]
}
application/json
Templates
List templates
The catalog’s design templates, each with the sections it supports.
get
Response
application/json
Response
application/json
Templates
dataarray[object]
Show Child Parameters
get/templates
Authentication
application/json