Intercom: Get Custom Object Instances By External ID

Get Custom Object Instance by External ID.

Tool ID: intercom_get_custom_object_instances_by_external_id

Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example. Inspect the live contract before executing it:

deepline tools get intercom_get_custom_object_instances_by_external_id --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "id": "id_123",
    "external_id": "external_123",
    "external_created_at": 1
  }
}

Use deepline tools get intercom_get_custom_object_instances_by_external_id --json for the latest machine-readable contract.

Input reference

Fetch a Custom Object Instance by external_id.

Name	Type	Required	Default	Details
`payload.custom_object_type_identifier`	`string`	Yes	—	The unique identifier of the custom object type that defines the structure of the custom object instance.
`payload.external_id`	`string`	Yes	—	The unique identifier for the instance in the external system it originated from.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.
`result.data.id`	`string`	No	—	The Intercom defined id representing the custom object instance.
`result.data.external_id`	`string`	No	—	The id you have defined for the custom object instance.
`result.data.external_created_at`	`integer \| null`	No	—	The time when the Custom Object instance was created in the external system it originated from. Format: `date-time`.
`result.data.external_updated_at`	`integer \| null`	No	—	The time when the Custom Object instance was last updated in the external system it originated from. Format: `date-time`.
`result.data.created_at`	`integer`	No	—	The time the attribute was created as a UTC Unix timestamp Format: `date-time`.
`result.data.updated_at`	`integer`	No	—	The time the attribute was last updated as a UTC Unix timestamp Format: `date-time`.
`result.data.type`	`string`	No	—	The identifier of the custom object type that defines the structure of the custom object instance.
`result.data.custom_attributes`	`record`	No	—	The custom attributes you have set on the custom object instance.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: Get Custom Object Instances By External ID

Run this action

Example response

Input reference

Output reference

Deepline cost

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation