Skip to main content
List Custom Entitys

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

id
string

Entity ID

created_at
string

Creation date

updated_at
string

Latest update

organisation_id
string

Organisation ID

custom_entity_definition_id
string

Custom entity definition ID

contact_id
string

Contact ID

external_id
string

External ID

data
string

Entity data matching the custom entity definition schema

select
string

Filtering Columns

order
string

Ordering. Allowed Fields: created_at, updated_at

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

200 - application/json

OK

id
string<uuid>
default:random uuid

Entity ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

custom_entity_definition_id
string<uuid>

Custom entity definition ID

contact_id
string<uuid>

Contact ID

external_id
string<text> | null

External ID

data
object

Entity data matching the custom entity definition schema