# Get Custom Object Instance by External ID

Fetch a Custom Object Instance by external_id.

Endpoint: GET /custom_object_instances/{custom_object_type_identifier}
Version: 2.14
Security: bearerAuth

## Path parameters:

  - `custom_object_type_identifier` (string, required)
    The unique identifier of the custom object type that defines the structure of the custom object instance.
    Example: "Order"

## Query parameters:

  - `external_id` (string, required)
    The unique identifier for the instance in the external system it originated from.

## Header parameters:

  - `Intercom-Version` (string)
    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", "2.11", "2.12", "2.13", "2.14", "Unstable"

## Response 200 fields (application/json):

  - `id` (string)
    The Intercom defined id representing the custom object instance.
    Example: 16032025

  - `external_id` (string)
    The id you have defined for the custom object instance.
    Example: "0001d1c1e65a7a19e9f59ae2"

  - `external_created_at` (integer,null)
    The time when the Custom Object instance was created in the external system it originated from.
    Example: 1571672154

  - `external_updated_at` (integer,null)
    The time when the Custom Object instance was last updated in the external system it originated from.
    Example: 1571672154

  - `created_at` (integer)
    The time the attribute was created as a UTC Unix timestamp
    Example: 1671028894

  - `updated_at` (integer)
    The time the attribute was last updated as a UTC Unix timestamp
    Example: 1671028894

  - `type` (string)
    The identifier of the custom object type that defines the structure of the custom object instance.
    Example: "Order"

  - `custom_attributes` (object)
    The custom attributes you have set on the custom object instance.

## Response 401 fields (application/json):

  - `type` (string, required)
    The type is error.list
    Example: "error.list"

  - `request_id` (string,null)
    Example: "f93ecfa8-d08a-4325-8694-89aeb89c8f85"

  - `errors` (array, required)
    An array of one or more error objects

  - `errors.code` (string, required)
    A string indicating the kind of error, used to further qualify the HTTP response code
    Example: "unauthorized"

  - `errors.message` (string,null)
    Optional. Human readable description of the error.
    Example: "Access Token Invalid"

  - `errors.field` (string,null)
    Optional. Used to identify a particular field or query parameter that was in error.
    Example: "email"

## Response 404 fields (application/json):

  - `type` (string, required)
    The type is error.list
    Example: "error.list"

  - `request_id` (string,null)
    Example: "f93ecfa8-d08a-4325-8694-89aeb89c8f85"

  - `errors` (array, required)
    An array of one or more error objects

  - `errors.code` (string, required)
    A string indicating the kind of error, used to further qualify the HTTP response code
    Example: "unauthorized"

  - `errors.message` (string,null)
    Optional. Human readable description of the error.
    Example: "Access Token Invalid"

  - `errors.field` (string,null)
    Optional. Used to identify a particular field or query parameter that was in error.
    Example: "email"