# Custom Object Instances

Schema: #/components/schemas/custom_object_instances_paginated_list

Method: SCHEMA
Version: 2.18
Security: bearerAuth

## Schema fields:

  - `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}

