Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Custom Object Instances

Get Custom Object Instance by External ID

Fetch a Custom Object Instance by external_id.

get/custom_object_instances/{custom_object_type_identifier}

Query parameters

external_idstring required

The unique identifier for the instance in the external system it originated from.

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

successful

idstring

The Intercom defined id representing the custom object instance.

external_idstring

The id you have defined for the custom object instance.

external_created_atinteger nullable

The time when the Custom Object instance was created in the external system it originated from.

external_updated_atinteger nullable

The time when the Custom Object instance was last updated in the external system it originated from.

created_atinteger

The time the attribute was created as a UTC Unix timestamp

updated_atinteger

The time the attribute was last updated as a UTC Unix timestamp

typestring

The identifier of the custom object type that defines the structure of the custom object instance.

custom_attributesobject

The custom attributes you have set on the custom object instance.

Example response

{
  "external_id": "0001d1c1e65a7a19e9f59ae2",
  "external_created_at": 1571672154,
  "external_updated_at": 1571672154,
  "created_at": 1671028894,
  "updated_at": 1671028894,
  "type": "Order"
}