Beta — endpoints, schemas, limits and examples may change before general availability.
Hellomateo API Documentation
DocumentationAPI Reference
Appointments

List Appointments

GET
/v1/appointments

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

contact?string
contact[in]?string
external_id?string
external_id[in]?string
status?string
status[in]?string
status_key?string
status_key[in]?string
type_key?string
type_key[in]?string
assignee?string
assignee[in]?string
assignee[is_null]?true
assignee[not_null]?true
start_time?string
start_time[neq]?string
start_time[gt]?string
start_time[gte]?string
start_time[lt]?string
start_time[lte]?string
end_time?string
end_time[neq]?string
end_time[gt]?string
end_time[gte]?string
end_time[lt]?string
end_time[lte]?string
end_time[is_null]?true
end_time[not_null]?true
confirmed_at?string
confirmed_at[neq]?string
confirmed_at[gt]?string
confirmed_at[gte]?string
confirmed_at[lt]?string
confirmed_at[lte]?string
confirmed_at[is_null]?true
confirmed_at[not_null]?true
cancelled_at?string
cancelled_at[neq]?string
cancelled_at[gt]?string
cancelled_at[gte]?string
cancelled_at[lt]?string
cancelled_at[lte]?string
cancelled_at[is_null]?true
cancelled_at[not_null]?true
limit?integer
Default10
Range0 <= value <= 100
page_token?string
Length1 <= length
include?array<>

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

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/appointments"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",      "name": "string",      "raw_description": "string",      "external_id": "string",      "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",      "status_key": "string",      "type_key": "string",      "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "start_time": "2019-08-24T14:15:22Z",      "start_time_date": "2019-08-24T14:15:22Z",      "start_time_time": "string",      "end_time": "2019-08-24T14:15:22Z",      "end_time_date": "2019-08-24T14:15:22Z",      "end_time_time": "string",      "confirmed_at": "2019-08-24T14:15:22Z",      "confirmed_at_date": "2019-08-24T14:15:22Z",      "confirmed_at_time": "string",      "cancelled_at": "2019-08-24T14:15:22Z",      "cancelled_at_date": "2019-08-24T14:15:22Z",      "cancelled_at_time": "string",      "calendar_id": "c828ce68-4c5a-4491-b76a-af3d888d3f97",      "scheduler_id": "652fd076-25b3-4e07-b0c6-b90a21476c1b",      "event_id": "string",      "deleted_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "contact": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "display_name": "string",        "full_name": "string",        "email": "string",        "sms": "string",        "whatsapp": "string",        "facebook": "string",        "instagram": "string",        "external_id": "string",        "secondary_external_id": "string",        "marketing_opt_in": true,        "number_of_marketing_opt_in_requests": 0,        "review_request_message_count": 0,        "is_blocked": true,        "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "salutation": "string",        "birthday": "2019-08-24T14:15:22Z",        "description": "string",        "email_marketing_messages_this_month": -9007199254740991,        "sms_marketing_messages_this_month": -9007199254740991,        "whatsapp_marketing_messages_this_month": -9007199254740991,        "facebook_marketing_messages_this_month": -9007199254740991,        "instagram_marketing_messages_this_month": -9007199254740991,        "google_business_messaging_marketing_messages_this_month": -9007199254740991,        "postal_marketing_messages_this_month": -9007199254740991,        "address_line1": "string",        "address_line2": "string",        "city": "string",        "country": "string",        "zipcode": "string",        "google_business_messaging": "string",        "postal": "string",        "email_health": "healthy",        "sms_health": "healthy",        "whatsapp_health": "healthy",        "facebook_health": "healthy",        "instagram_health": "healthy",        "google_business_messaging_health": "healthy",        "postal_health": "healthy",        "email_marketing_opt_in": true,        "sms_marketing_opt_in": true,        "whatsapp_marketing_opt_in": true,        "facebook_marketing_opt_in": true,        "instagram_marketing_opt_in": true,        "google_business_messaging_marketing_opt_in": true,        "postal_marketing_opt_in": true,        "email_transactional_opt_in": "consent_granted",        "sms_transactional_opt_in": "consent_granted",        "whatsapp_transactional_opt_in": "consent_granted",        "facebook_transactional_opt_in": "consent_granted",        "instagram_transactional_opt_in": "consent_granted",        "google_business_messaging_transactional_opt_in": "consent_granted",        "postal_transactional_opt_in": "consent_granted",        "last_review_rating": 0,        "last_interaction_at": "2019-08-24T14:15:22Z",        "last_outbound_at": "2019-08-24T14:15:22Z"      },      "status": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",        "appointment_type_id": "a556be33-8c12-4697-8c57-2c069da799cf",        "idx": 9007199254740991,        "name": "string",        "type": "cancelled",        "key": "string",        "is_gallery": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "appointment_type": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",          "name": "string",          "description": "string",          "external_id": "string",          "key": "string",          "emoji": "string",          "scheduling_enabled": true,          "is_gallery": true,          "gallery_key": "string",          "deleted_at": "2019-08-24T14:15:22Z",          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z",          "statuses": [            {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",              "appointment_type_id": "a556be33-8c12-4697-8c57-2c069da799cf",              "idx": 9007199254740991,              "name": "string",              "type": "cancelled",              "key": "string",              "is_gallery": true,              "created_at": "2019-08-24T14:15:22Z",              "updated_at": "2019-08-24T14:15:22Z"            }          ]        }      },      "assignee": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "display_name": "string",        "username": "string",        "full_name": "string",        "email": "string",        "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",        "is_admin": true,        "signature": "string",        "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",        "locale": "string",        "enable_shortcuts": true,        "is_web_push_enabled": true,        "is_mobile_push_enabled": true,        "is_active": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "calendar": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",        "name": "string",        "external_id": "string",        "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",        "calendar_resource_id": "b91c4c5a-de69-4276-8281-8d05c6c9e77d",        "type": "provider",        "is_default": true,        "scheduling_enabled": true,        "yes_status_id": "b6b6528e-788f-4a4d-a6c8-64c1c612ade2",        "no_status_id": "477cd436-3b4e-4818-a9d2-2216ccb162b5",        "maybe_status_id": "e92edbf2-e54f-452d-a748-1b96f0474ede",        "noreply_status_id": "40575e6a-32c0-4359-ba17-1fcf9f26f963",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "participants": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",          "name": "string",          "external_id": "string",          "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",          "calendar_resource_id": "b91c4c5a-de69-4276-8281-8d05c6c9e77d",          "type": "provider",          "is_default": true,          "scheduling_enabled": true,          "yes_status_id": "b6b6528e-788f-4a4d-a6c8-64c1c612ade2",          "no_status_id": "477cd436-3b4e-4818-a9d2-2216ccb162b5",          "maybe_status_id": "e92edbf2-e54f-452d-a748-1b96f0474ede",          "noreply_status_id": "40575e6a-32c0-4359-ba17-1fcf9f26f963",          "created_at": "2019-08-24T14:15:22Z",          "updated_at": "2019-08-24T14:15:22Z"        }      ],      "scheduler": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",        "name": "string",        "appointment_type_id": "a556be33-8c12-4697-8c57-2c069da799cf",        "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",        "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",        "appointment_scheduler_type": "nylas",        "event_booking_config": null,        "scheduler_settings": null,        "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"}

Get Appointment GET

Previous Page

Update Appointment By Locator PATCH

Next Page