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

List Appointment Types

GET
/v1/appointment-types

Returns a paginated list of appointment Types.

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.

key?string

Stable key used to identify the resource.

key[in]?string

Filters by any of the supplied key values.

external_id?string

Identifier assigned by an external system.

external_id[in]?string

Filters by any of the supplied external id 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
include?array<"scheduler" | "statuses">

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

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/appointment-types"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "external_id": "string",      "key": "string",      "emoji": "string",      "scheduling_enabled": true,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "scheduler": {        "additional_fields": [          {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "key": "string",            "label": "string",            "value_type": "string"          }        ]      },      "statuses": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "key": "string",          "name": "string",          "type": "cancelled",          "idx": 9007199254740991        }      ]    }  ],  "next_page_url": "string",  "previous_page_url": "string"}

Get Appointment Type GET

Returns the requested appointment Type.

Update Appointment Type by Locator PATCH

Updates the appointment type resolved by exactly one of id, key, or external_id within this organisation. Gallery and deleted appointment types are excluded. key cannot be changed; external_id can be changed, so subsequent locator requests must use the new value.