Intercom API (unofficial showcase)
GET/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}

Retrieve a custom object instance by ID

Retrieves a custom object instance by its Intercom-defined ID or external ID. Use custom_object_type_identifier to specify the instance type and custom_object_instance_id to identify the instance.

3 parameters
custom_object_type_identifierstringrequired
The unique identifier of the custom object type that defines the instance structure.
custom_object_instance_idstringrequired
The Intercom-defined ID or external ID of the custom object instance.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the custom object instance, including its identifiers, timestamps, type, and custom attributes.
idstringoptional
The Intercom defined id representing the custom object instance.
external_idstringoptional
The id you have defined for the custom object instance.
external_created_atintegeroptional
The time when the Custom Object instance was created in the external system it originated from.
external_updated_atintegeroptional
The time when the Custom Object instance was last updated in the external system it originated from.
created_atintegeroptional
The time the attribute was created as a UTC Unix timestamp
updated_atintegeroptional
The time the attribute was last updated as a UTC Unix timestamp
typestringoptional
The identifier of the custom object type that defines the structure of the custom object instance.
custom_attributesobjectoptional
The custom attributes you have set on the custom object instance.
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
404Returned when the custom object type or instance is not found.

2 documented failures

  • not_found

    Object not found

  • data_invalid

    Integration 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 the request is unauthorized, and a 404 is returned when the custom object type or instance is not found. The custom_object_type_identifier path parameter must identify the type, and custom_object_instance_id must be the instance's Intercom-defined ID or external ID.