Get Custom Object Instance by ID

REST API Reference

Fetch a Custom Object Instance by id.

SecurityHTTP: bearerAuth

Request

path Parameters

custom_object_type_identifier required	string The unique identifier of the custom object type that defines the structure of the custom object instance. Example: Order
id required	string The id or external_id of the custom object instance

header Parameters

Intercom-Version

string (intercom_version)

Default: Unstable

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

Enum: "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" "Unstable"

Example: Unstable

get

/custom_object_instances/{custom_object_type_identifier}/{id}

Request samples

Responses

200

successful

Response Schema: application/json

id	string The Intercom defined id representing the custom object instance.
external_id	string The id you have defined for the custom object instance.
type	string The identifier of the custom object type that defines the structure of the custom object instance.
	object The custom attributes you have set on the custom object instance.

401

Unauthorized

Response samples
200
401
application/json
successful
{
"id": "4",
"type": "object_type_identifier_6",
"custom_attributes": { },
"external_id": "123",
"external_created_at": null,
"external_updated_at": null,
"created_at": 1713520878,
"updated_at": 1713520878
}