Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
Custom Entities

List Custom Entities

GET
/v1/custom-entities

Returns a paginated list of custom Entities.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

id?string

Unique identifier for the resource.

id[in]?string

Filters by any of the supplied id values.

custom_entity_definition?string

Filters resources by custom entity definition.

custom_entity_definition[in]?string

Filters by any of the supplied custom entity definition values.

contact?string

Filters resources by contact.

contact[in]?string

Filters by any of the supplied contact values.

external_id?string

Identifier assigned by an external system.

external_id[in]?string

Filters by any of the supplied external id values.

external_id[is_null]?true

Filters for resources where external id is null.

external_id[not_null]?true

Filters for resources where external id is not null.

custom_entity_definition_key?string

Stable key of the definition that validates the custom entity.

custom_entity_definition_key[in]?string

Filters by any of the supplied custom entity definition key values.

limit?integer

Maximum number of resources to return.

Default10
Range0 <= value <= 100
page_token?string

Opaque token returned by a previous page request.

Length1 <= length

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/custom-entities"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "custom_entity_definition_id": "7d69c76b-fbd6-4171-a3bd-6ed8ca83d88f",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "external_id": "string",      "data": {        "property1": null,        "property2": null      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_page_url": "string",  "previous_page_url": "string"}