Intercom API (unofficial showcase)
GET/dynamic_contents/{id}

Retrieve dynamic content

Retrieves a single reusable dynamic content item by its unique identifier. Use the id path parameter to select the item and the Intercom-Version header to choose an API version. The authenticated user needs the read_dynamic_content scope.

2 parameters
idstringrequired
The unique identifier of the dynamic content to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to `2.17` when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns the dynamic content object, including its identifier, name, key, content type, default locale, variations, and creation and update timestamps.
typestringoptional
String representing the object's type. Always has the value `dynamic_content`.
idstringoptional
The unique identifier for the dynamic content.
namestringoptional
The name of the dynamic content.
keystringoptional
The identifier that articles use to reference the dynamic content. Derived from the name when the dynamic content is created, and never changes.
content_typestringoptional
Whether the dynamic content is a short inline value (`inline`) or one or more blocks of content (`block`).
Allowed:inlineblock
default_localestringoptional
The locale whose variation is used when there's no variation for the requested locale.
variationsarray<DynamicContentVariation>optional
The variations of the dynamic content.
created_atintegeroptional
The time the dynamic content was created as a Unix timestamp.
updated_atintegeroptional
The time the dynamic content was last updated as a Unix timestamp.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when dynamic content is not enabled.

One documented failure

  • api_plan_restricted

    Dynamic content is not enabled for this workspace

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the requested dynamic content is not found.

One documented failure

  • not_found

    Dynamic content not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when authentication fails, a 403 when dynamic content is not enabled, and a 404 when the dynamic content is not found. The id path parameter must identify the dynamic content to retrieve, and the authenticated user needs the read_dynamic_content scope.