REST APIActivities and communicationAppointments
Appointments
Appointments: list, get, create, update and delete, plus batch operations.
- 8 operations
- 57 fields
- Schema Appointment
- GraphQL: appointment
The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.
| Method | Path | Operation |
|---|---|---|
| GET | /entities/Appointments | List Appointments |
| POST | /entities/Appointments | Create Appointment |
| GET | /entities/Appointments/{id} | Get Appointment |
| PATCH | /entities/Appointments/{id} | Update Appointment |
| DEL | /entities/Appointments/{id} | Delete Appointment |
| POST | /entities/Appointments/batch-modify | Create or update Appointments in a batch |
| POST | /entities/Appointments/batch-delete | Delete Appointments in a batch |
| POST | /entities/Appointments/batch-restore | Restore deleted Appointments |
GET List Appointments
Returns the Appointments the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.
Query parameters
| Name | Type | Description |
|---|---|---|
include-deleted | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
first | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. |
last | integer | Return the last N records of the result; together with first, the last N of the first M. Maximum 100. |
before | string | Cursor from page_info.start_cursor, to page backwards. URL-encode it. |
after | string | Cursor from page_info.end_cursor of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
expand | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in account_relations.account. |
order-by | string | Fields to sort by, comma-separated. A leading - sorts descending, as in -modified; dotted paths sort by related fields. |
filter | object | filter[field]=value. Separate several values with a raw comma (OR), as in filter[name]=north,south. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in filter[owner.email]. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
filter-op | object | filter-op[field]=operator, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
load-only | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in owner.id. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |
Responses
200 Page of Appointment records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments?first=10' \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments?first=10', {
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.get(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments",
params={
"first": "10"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)POST Create Appointment
Creates one record and answers 201 with it.
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
Request body
The new record's fields. Relations are set by id. Schema createAppointmentInput; the fields are in Appointment fields. Required: end_date, owner_id, subject.
Responses
201 The created Appointment record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '{
"end_date": "2026-10-13T09:00:00+00:00",
"owner_id": "37000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment)"
}'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify({
end_date: '2026-10-13T09:00:00+00:00',
owner_id: '37000000-0000-4000-a000-000000000001',
subject: 'Follow up with Northwind Analytics (appointment)'
})
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json={
"end_date": "2026-10-13T09:00:00+00:00",
"owner_id": "37000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment)"
}
)GET Get Appointment
Returns one record by id. expand returns related records inline instead of their URIs.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the Appointment record to retrieve. Required |
Query parameters
| Name | Type | Description |
|---|---|---|
expand | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |
Responses
200 The Appointment record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001?expand=owner' \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001?expand=owner', {
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.get(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001",
params={
"expand": "owner"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)PATCH Update Appointment
Changes the fields you send and leaves the rest as they are; there is no PUT.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the Appointment record to update. Required |
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
Request body
The fields to change. Schema updateAppointmentInput; the fields are in Appointment fields.
Responses
200 The changed Appointment record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001' \
--request PATCH \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '{
"subject": "Follow up with Northwind Analytics (appointment) (renamed)"
}'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001', {
method: 'PATCH',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify({
subject: 'Follow up with Northwind Analytics (appointment) (renamed)'
})
})import os
import requests
response = requests.patch(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json={
"subject": "Follow up with Northwind Analytics (appointment) (renamed)"
}
)DEL Delete Appointment
Deletes one record and answers with its id.
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | Id of the Appointment record to delete. Required |
Responses
200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001' \
--request DELETE \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET"fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001', {
method: 'DELETE',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
}
})import os
import requests
response = requests.delete(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/0b000000-0000-4000-a000-000000000001",
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)POST Create or update Appointments in a batch
An item with an id updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the response has an id or an error for each item, in input order.
Query parameters
| Name | Type | Description |
|---|---|---|
validation-level | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of records: an item with an id updates, an item without one creates. Schema batchAppointmentInput; the fields are in Appointment fields. Required: end_date, owner_id, subject.
Responses
200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-modify' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
{
"end_date": "2026-10-13T09:00:00+00:00",
"owner_id": "37000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment)"
},
{
"id": "0b000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment) (renamed)"
}
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-modify', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify([
{
end_date: '2026-10-13T09:00:00+00:00',
owner_id: '37000000-0000-4000-a000-000000000001',
subject: 'Follow up with Northwind Analytics (appointment)'
},
{
id: '0b000000-0000-4000-a000-000000000001',
subject: 'Follow up with Northwind Analytics (appointment) (renamed)'
}
])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-modify",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
{
"end_date": "2026-10-13T09:00:00+00:00",
"owner_id": "37000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment)"
},
{
"id": "0b000000-0000-4000-a000-000000000001",
"subject": "Follow up with Northwind Analytics (appointment) (renamed)"
}
]
)POST Delete Appointments in a batch
Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.
Query parameters
| Name | Type | Description |
|---|---|---|
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of ids.
Responses
200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-delete' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
"0b000000-0000-4000-a000-000000000001",
"0b000000-0000-4000-a000-000000000002"
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-delete', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify(['0b000000-0000-4000-a000-000000000001', '0b000000-0000-4000-a000-000000000002'])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-delete",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
"0b000000-0000-4000-a000-000000000001",
"0b000000-0000-4000-a000-000000000002"
]
)POST Restore deleted Appointments
Restores the deleted records whose ids are in the body, a JSON array.
Query parameters
| Name | Type | Description |
|---|---|---|
rollback-method | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. |
Request body
A JSON array of ids.
Responses
200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-restore' \
--request POST \
--user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
--header 'Content-Type: application/json' \
--data '[
"0b000000-0000-4000-a000-000000000001",
"0b000000-0000-4000-a000-000000000002"
]'fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-restore', {
method: 'POST',
headers: {
Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
'Content-Type': 'application/json'
},
body: JSON.stringify(['0b000000-0000-4000-a000-000000000001', '0b000000-0000-4000-a000-000000000002'])
})import os
import requests
response = requests.post(
"https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Appointments/batch-restore",
headers={
"Content-Type": "application/json"
},
auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
json=[
"0b000000-0000-4000-a000-000000000001",
"0b000000-0000-4000-a000-000000000002"
]
)Appointment fields
| Field | Type | Notes |
|---|---|---|
id | uuid | Read-only Unique identifier of entity. |
end_date | date-time | Required on create End timestamp of the appointment. |
owner_id | uuid → Clients | Required on create Id of the appointment owner. |
subject | string | Required on create Short summary line shown in calendars and lists. |
media_transcription_id | uuid | Id of the linked Media record holding the activity's call recording / transcription, when available. |
activity_type_id | uuid → AppointmentTypes | Id of the appointment type. |
currency_exchange_rates_list_id | uuid → CurrencyExchangeRatesLists | Id of the currency exchange rate list applied to this appointment. |
description | string | Free-form description of the appointment. |
duration | number | Duration of the appointment, derived from start/end dates. |
invitees_can_edit | boolean | True when invitees are allowed to edit the appointment. |
is_recurrence_active | boolean | True when the recurrence series is still generating new occurrences. |
is_recurrence_exception | boolean | True when this occurrence has been modified independently of the recurring series. |
location | string | Free-text physical location of the appointment. |
meeting_url | object | Online meeting link associated with the appointment (join URL plus meeting type, e.g. |
occurence_date | date-time | Original date of this occurrence in the recurring series. |
Show all 57 fields
| Field | Type | Notes |
|---|---|---|
organizer | string | Email of the user organising the appointment. |
recurrence_master_id | uuid → Appointments | Id of the master appointment. |
recurrence_rule | string | iCalendar RRULE string describing the recurrence pattern (e.g. |
recurrence_tzid | string | IANA timezone the recurrence rule is evaluated in. |
schedule_id | uuid → AppointmentSchedules | Id of the appointment schedule. |
schedule_tzid | string | IANA timezone the appointment was booked in (e.g. |
start_date | date-time | Start timestamp of the appointment. |
unit_id | uuid → SalesUnits | Id of the sales unit. |
revision | integer | Revision when entity was lastly changed. |
account_relations | array of uri → ActivityRelations | Accounts this appointment is linked to. |
contact_relations | array of uri → ActivityRelations | Contacts this appointment is linked to. |
lead_relations | array of uri → ActivityRelations | Leads this appointment is linked to. |
opportunity_relations | array of uri → ActivityRelations | Opportunities this appointment is linked to. |
project_relations | array of uri → ActivityRelations | Projects this appointment is linked to, including the per-objective ordering. |
quote_relations | array of uri → ActivityRelations | Quotes this appointment is linked to. |
custom_entity_relations | array of uri → ActivityRelations | Custom entity records this appointment is linked to. |
invitees_contacts | array of uri → AppointmentContactInviteesRelations | Non-user invitees on this appointment, identified by email. |
invitees_clients | array of uri → AppointmentClientInviteesRelations | Internal-user invitees on this appointment. |
exchange_entity_id | string | External identifier of the record in the linked third-party service (e.g. |
gapi_entity_id | string | External identifier of the record in the linked third-party service (e.g. |
o365_entity_id | string | External identifier of the record in the linked third-party service (e.g. |
reminder | uri → AppointmentReminders | Reminder set by the current authenticated user for this appointment. |
documents | array of uri → CloudObjectRelations | Documents linked to this appointment. |
comments | array of uri → ActivityComments | Comments authored on this appointment. |
tags | array of uri → TagRelations | Tag labels applied to this appointment. |
is_delete_protected | boolean | Read-only True when the record is protected against deletion because it must always exist in the space. |
active_reminder | date-time | Read-only Timestamp of the next pending reminder configured for the activity (reminder time, due date or end date as applicable). |
is_deleted | boolean | Read-only Specifies if the entity is considered deleted. |
modified | date-time | Read-only Last modification time. |
created | date-time | Read-only Creation time. |
activity_type | uri → AppointmentTypes | Read-only Appointment type that classifies this appointment. |
currency_exchange_rates_list | uri → CurrencyExchangeRatesLists | Read-only Currency exchange rate list used to convert monetary fields linked to this appointment. |
owner | uri → Clients | Read-only Sales user who owns this appointment. |
recurrence_master | uri → Appointments | Read-only Master appointment of the recurring series this occurrence belongs to. |
schedule | uri → AppointmentSchedules | Read-only Appointment schedule (booking link) this appointment was created through, or empty for appointments created directly. |
unit | uri → SalesUnits | Read-only Sales unit this appointment is assigned to. |
table_name | string | Read-only Discriminator identifying the concrete record type — always "appointment" for Appointment records. |
status | integer | Read-only Current status of the appointment (NotStarted, InProgress, Completed, Canceled).1 NotStarted · 2 InProgress · 3 Waiting · 4 Completed · 5 Deferred · 6 Canceled |
has_3rd_party_mapping | boolean | Read-only True when this appointment is mirrored to an external calendar (Office 365, Exchange, Google). |
formatted_name | string | Read-only Display name of the appointment (alias of subject). |
recurrence | object | Read-only Recurrence configuration for recurring appointments (parsed RRULE plus exception metadata). |
modified_by_user | date-time | Read-only Timestamp of the most recent modification made by an end user (excluding system changes). |
Custom fields appear in your space's live spec: fetch it with your credentials.
Errors
Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.
| HTTP | When |
|---|---|
| 400 | Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check code. |
| 401 | Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). |
| 404 | No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |
Webhook events for appointments
Appointment.Comment Appointment.Create Appointment.Delete Appointment.DocumentLinked Appointment.OwnerChanged Appointment.Update See payloads
Subscribe with Create a webhook.