# List Custom Object Instances

List instances of a custom object type. Three modes are supported:
- **No filter**
 — returns all instances for the type.
- **`references_contact_id`**
 — returns instances associated with the given contact.
- **`references_conversation_id`**
 — returns instances associated with the given conversation.

When **`external_id`** is provided, returns a single matching instance (not a list). If no instance matches, the response is still `200`, with the same body the single-instance endpoint returns for a miss.
Requires the `read_conversations`, `read_users_companies`, `read_write_custom_object_instances` or `read_write_users` OAuth scope.

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

## Security:

  - `bearerAuth` (unknown)
    http bearer

## 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.

## Query parameters:

  - `references_contact_id` (string)
    Return instances associated with the given contact ID.

  - `references_conversation_id` (string)
    Return instances associated with the given conversation ID.

  - `external_id` (string)
    Return the single instance with this external ID. When provided, the response is a single object rather than a list.

  - `page` (integer)
    Page number of results to fetch.

  - `per_page` (integer)
    Number of results per page. Maximum 150.

## Header parameters:

  - `Intercom-Version` (string)

## Response 200:

  - `200` (unknown)
    successful

## Response 200 fields (application/json):

  - `type` (string)
    The type of the object - `list`.
    Enum: "list"

  - `pages` (object)
    The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

  - `pages.type` (string)
    Enum: "pages"

  - `pages.page` (integer)
    Example: 1

  - `pages.next` (string)
    A link to the next page of results. Omitted or `null` on the last page, depending on the list. Some lists never include `next` or `prev`, so compare `page` with `total_pages` to tell whether more pages remain.

  - `pages.prev` (string)
    A link to the previous page of results. Omitted on the first page.

  - `pages.per_page` (integer)
    Example: 50

  - `pages.total_pages` (integer)
    Example: 1

  - `total_count` (integer)
    A count of the total number of custom object instances.
    Example: 2

  - `data` (array)
    An array of Custom Object Instance objects.

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

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

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

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

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

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

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

  - `data.custom_attributes` (object)
    The custom attributes you have set on the custom object instance.
Each value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or `null` when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under `contacts` for a contact reference, `conversations` for a conversation reference, or `instances` for a reference to another custom object type.
    Example: {"order_number":"ORDER-12345","total_amount":99.99}

  - `found` (boolean, required)
    Always `false`. Only present on this response.
    Example: false

  - `id` (string)
    The requested id, echoed back. Null when looked up by `external_id`.

  - `external_id` (string)
    The requested external_id, echoed back. Null when looked up by `id`.

  - `type` (string)
    The identifier of the custom object type that was queried.
    Example: Order

  - `custom_attributes` (object)
    Always an empty object.

  - `external_created_at` (integer)

  - `external_updated_at` (integer)

  - `created_at` (integer)

  - `updated_at` (integer)

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 400 fields (application/json):

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

  - `request_id` (string)
    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)
    Optional. Human readable description of the error.
    Example: Access Token Invalid

  - `errors.data` (object)
    Optional. Extra detail about the error, for example `required_permissions` on a 403 `action_forbidden` error.
    Example: {"required_permissions":["read_conversations"]}

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

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

  - `request_id` (string)
    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)
    Optional. Human readable description of the error.
    Example: Access Token Invalid

  - `errors.data` (object)
    Optional. Extra detail about the error, for example `required_permissions` on a 403 `action_forbidden` error.
    Example: {"required_permissions":["read_conversations"]}

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

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

  - `request_id` (string)
    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)
    Optional. Human readable description of the error.
    Example: Access Token Invalid

  - `errors.data` (object)
    Optional. Extra detail about the error, for example `required_permissions` on a 403 `action_forbidden` error.
    Example: {"required_permissions":["read_conversations"]}

## Response 200 examples:

  - `successful` (unknown)

## Response 400 examples:

  - `Both reference filters given` (unknown)

## Response 401 examples:

  - `Unauthorized` (unknown)

## Response 404 examples:

  - `TypeNotFound` (unknown)

