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

List Contacts

GET
/v1/contacts

Returns a paginated list of contacts.

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.

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.

updated_at?string

Timestamp when the resource was last updated.

Formatdate-time
updated_at[gte]?string

Filters resources by updated at using the gte operator.

Formatdate-time
updated_at[lte]?string

Filters resources by updated at using the lte operator.

Formatdate-time
updated_at[gt]?string

Filters resources by updated at using the gt operator.

Formatdate-time
updated_at[lt]?string

Filters resources by updated at using the lt operator.

Formatdate-time
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
include?array<"identities" | "channels">

Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar.

include_details?array<string>

Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar.

Itemsitems <= 10

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/contacts"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "display_name": "string",      "full_name": "string",      "salutation": "string",      "birthday": "2019-08-24T14:15:22Z",      "description": "string",      "external_id": "string",      "secondary_external_id": "string",      "address_line1": "string",      "address_line2": "string",      "city": "string",      "zipcode": "string",      "country": "string",      "is_blocked": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "identities": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",          "channel_type": "email",          "type": "string",          "value": "string",          "scope_type": "string",          "scope_id": "string",          "health": "healthy",          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z"        }      ],      "channels": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",          "channel_type": "email",          "health": "healthy",          "transactional_opt_in": "consent_granted",          "marketing_subscription_status": "requested",          "marketing_messages_this_month": 32767,          "messages_this_month": 32767,          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z"        }      ],      "property1": null,      "property2": null    }  ],  "next_page_url": "string",  "previous_page_url": "string"}