Skip to main content
List Custom Entity Definitions
curl --request GET \
  --url https://integration.getmateo.com/api/v1/custom_entity_definition \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "name": "<string>",
    "schema": {}
  }
]

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

Custom entity definition ID

​
created_at
string

Creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
key
string

Unique key for the custom entity definition

​
name
string

Name of the custom entity definition

​
schema
string

JSON Schema defining the custom entity data structure

​
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

Custom entity definition 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

​
key
string<text>

Unique key for the custom entity definition

​
name
string<text>

Name of the custom entity definition

​
schema
object

JSON Schema defining the custom entity data structure