---
title: AppointmentSchedules
description: "AppointmentSchedules: list, get, create, update and delete, plus batch operations."
canonical: https://developers.coevera.com/reference/rest/appointment-schedules/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# AppointmentSchedules

AppointmentSchedules: list, get, create, update and delete, plus batch operations.

Family: Activities and communication. GraphQL: [appointmentSchedule](https://developers.coevera.com/reference/graphql/appointment-schedule.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/AppointmentSchedules` | List AppointmentSchedules |
| POST | `/entities/AppointmentSchedules` | Create AppointmentSchedule |
| GET | `/entities/AppointmentSchedules/{id}` | Get AppointmentSchedule |
| PATCH | `/entities/AppointmentSchedules/{id}` | Update AppointmentSchedule |
| DELETE | `/entities/AppointmentSchedules/{id}` | Delete AppointmentSchedule |
| POST | `/entities/AppointmentSchedules/batch-modify` | Create or update AppointmentSchedules in a batch |
| POST | `/entities/AppointmentSchedules/batch-delete` | Delete AppointmentSchedules in a batch |
| POST | `/entities/AppointmentSchedules/batch-restore` | Restore deleted AppointmentSchedules |

## List AppointmentSchedules

`GET /entities/AppointmentSchedules`

Returns the AppointmentSchedules the API application can read, one page at a time. In the list envelope, `total` counts every match and `page_info` pages through them.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | 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` | query | 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` | query | 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 AppointmentSchedule records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create AppointmentSchedule

`POST /entities/AppointmentSchedules`

Creates one record and answers 201 with it.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | 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 `createAppointmentScheduleInput`. Required: `appointment_description`, `appointment_location`, `appointment_owner_id`, `appointment_subject`, `appointment_subject_uses_schedule_name`, `appointment_type_id`, `buffer_time_after`, `buffer_time_before`, `is_enabled`, `minimum_notice_time`, `name`, `owner_id`, `planning_day_offset`, `reminder_email_enabled`, `reminder_email_offset`, `schedule_name`, `time_increment`, `url`, `additional_fields_data`, `availability_data`, `appointment_invitees_data`.

Responses: 201 (The created AppointmentSchedule record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "appointment_description": "Northwind appointment description",
  "appointment_location": "Northwind appointment location",
  "appointment_owner_id": "37000000-0000-4000-a000-000000000001",
  "appointment_subject": "Northwind appointment subject",
  "appointment_subject_uses_schedule_name": false,
  "appointment_type_id": "6b000000-0000-4000-a000-000000000001",
  "buffer_time_after": 1,
  "buffer_time_before": 1,
  "is_enabled": false,
  "minimum_notice_time": 1,
  "name": "Northwind appointment schedule",
  "owner_id": "37000000-0000-4000-a000-000000000001",
  "planning_day_offset": 1,
  "reminder_email_enabled": false,
  "reminder_email_offset": 1,
  "schedule_name": "Northwind schedule name",
  "time_increment": 1,
  "url": "https://hooks.example.com/coevera",
  "additional_fields_data": [],
  "availability_data": {},
  "appointment_invitees_data": []
}'
```

## Get AppointmentSchedule

`GET /entities/AppointmentSchedules/{id}`

Returns one record by id. `expand` returns related records inline instead of their URIs.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the AppointmentSchedule record to retrieve. |
| `expand` | query | 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 AppointmentSchedule record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/64000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Update AppointmentSchedule

`PATCH /entities/AppointmentSchedules/{id}`

Changes the fields you send and leaves the rest as they are; there is no PUT.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the AppointmentSchedule record to update. |
| `validation-level` | query | 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 `updateAppointmentScheduleInput`.

Responses: 200 (The changed AppointmentSchedule record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/64000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind appointment schedule (renamed)"
}'
```

## Delete AppointmentSchedule

`DELETE /entities/AppointmentSchedules/{id}`

Deletes one record and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the AppointmentSchedule record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/64000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create or update AppointmentSchedules in a batch

`POST /entities/AppointmentSchedules/batch-modify`

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.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | 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` | query | 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. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchAppointmentScheduleInput`. Required: `appointment_description`, `appointment_location`, `appointment_owner_id`, `appointment_subject`, `appointment_subject_uses_schedule_name`, `appointment_type_id`, `buffer_time_after`, `buffer_time_before`, `is_enabled`, `minimum_notice_time`, `name`, `owner_id`, `planning_day_offset`, `reminder_email_enabled`, `reminder_email_offset`, `schedule_name`, `time_increment`, `url`, `additional_fields_data`, `availability_data`, `appointment_invitees_data`.

Responses: 200 (Result per item, in request order: the id of the created or updated record, or the error.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "appointment_description": "Northwind appointment description",
    "appointment_location": "Northwind appointment location",
    "appointment_owner_id": "37000000-0000-4000-a000-000000000001",
    "appointment_subject": "Northwind appointment subject",
    "appointment_subject_uses_schedule_name": false,
    "appointment_type_id": "6b000000-0000-4000-a000-000000000001",
    "buffer_time_after": 1,
    "buffer_time_before": 1,
    "is_enabled": false,
    "minimum_notice_time": 1,
    "name": "Northwind appointment schedule",
    "owner_id": "37000000-0000-4000-a000-000000000001",
    "planning_day_offset": 1,
    "reminder_email_enabled": false,
    "reminder_email_offset": 1,
    "schedule_name": "Northwind schedule name",
    "time_increment": 1,
    "url": "https://hooks.example.com/coevera",
    "additional_fields_data": [],
    "availability_data": {},
    "appointment_invitees_data": []
  },
  {
    "id": "64000000-0000-4000-a000-000000000001",
    "name": "Northwind appointment schedule (renamed)"
  }
]'
```

## Delete AppointmentSchedules in a batch

`POST /entities/AppointmentSchedules/batch-delete`

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | 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. (default 0) |

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, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "64000000-0000-4000-a000-000000000001",
  "64000000-0000-4000-a000-000000000002"
]'
```

## Restore deleted AppointmentSchedules

`POST /entities/AppointmentSchedules/batch-restore`

Restores the deleted records whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | 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. (default 0) |

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, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/AppointmentSchedules/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "64000000-0000-4000-a000-000000000001",
  "64000000-0000-4000-a000-000000000002"
]'
```

## AppointmentSchedule fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `appointment_description` | string | Required on create. Description applied to appointments booked through this schedule. |
| `appointment_location` | string | Required on create. Location applied to appointments booked through this schedule. |
| `appointment_owner_id` | uuid → Clients | Required on create. Id of the user receiving the booking. |
| `appointment_subject` | string | Required on create. Subject applied to appointments booked through this schedule. |
| `appointment_subject_uses_schedule_name` | boolean | Required on create. When true, booked appointments use the schedule_name as their subject instead of appointment_subject. |
| `appointment_type_id` | uuid → AppointmentTypes | Required on create. Id of the appointment type used for appointments booked through the schedule. |
| `buffer_time_after` | integer | Required on create. Buffer in seconds kept free after each booked appointment (e.g. |
| `buffer_time_before` | integer | Required on create. Buffer in seconds kept free before each booked appointment (e.g. |
| `is_enabled` | boolean | Required on create. Master switch for the schedule. |
| `minimum_notice_time` | integer | Required on create. Minimum notice in seconds required before a slot can be booked (e.g. |
| `name` | string | Required on create. Admin-only name for the schedule, used in pickers and lists. |
| `owner_id` | uuid → Clients | Required on create. Id of the schedule owner. |
| `planning_day_offset` | integer | Required on create. With Offset planning, how many days ahead the schedule remains bookable. |
| `reminder_email_enabled` | boolean | Required on create. True when a reminder email is sent to invitees ahead of the booked appointment. |
| `reminder_email_offset` | integer | Required on create. Time before the appointment when the reminder email is sent. |
| `schedule_name` | string | Required on create. Public-facing name of the schedule, shown to bookers on the booking page. |
| `time_increment` | integer | Required on create. Step in seconds between offered start times (e.g. |
| `url` | string | Required on create. Public URL slug of the schedule, used to share the booking page. |
| `additional_fields_data` | array of object | Required on create. Custom fields the booker is asked to fill in on the booking page, in display order. |
| `availability_data` | object | Required on create. Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone. |
| `appointment_invitees_data` | array of object | Required on create. Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). |
| `appointment_duration` | number | Duration of each booked appointment. |
| `appointment_location_type` | integer | Where booked appointments take place: the location given in appointment_location (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. Values: 0 Custom, 1 Microsoft, 2 Zoom. |
| `availability_tzid` | string | IANA timezone (e.g. |
| `confirmation_page_type` | integer | What is shown to the booker after confirming (e.g. Values: 0 ConfirmationPage, 1 ExternalUrl. |
| `confirmation_page_url` | string | Custom URL the booker is redirected to after confirming. |
| `planning_period_from` | date | With Period planning, first date bookings are accepted for. |
| `planning_period_to` | date | With Period planning, last date bookings are accepted for. |
| `planning_type` | integer | Time window in which the schedule accepts bookings: any future date (Infinite), up to planning_day_offset days ahead (Offset), or between planning_period_from … Values: 0 Infinite, 1 Offset, 2 Period. |
| `reminder_email_offset_type` | integer | Time unit of reminder_email_offset: Minute, Hour, Day or Week. Values: 0 Minute, 1 Hour, 2 Day, 3 Week. |
| `reply_company_email_id` | uuid → CompanyEmails | Id of the company email used as the From / Reply-To on schedule confirmation emails. |
| `type` | integer | Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. Values: 0 OneToOne, 1 Group. |
| `is_delete_protected` | boolean | Read-only. True when the record is protected against deletion because it must always exist in the space. |
| `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. |
| `appointment_owner` | uri → Clients | Read-only. User assigned as the appointment owner when a booking is made through this schedule. |
| `appointment_type` | uri → AppointmentTypes | Read-only. Appointment type used when a booking is created. |
| `owner` | uri → Clients | Read-only. Owner of the schedule (typically the team member whose availability is exposed). |
| `reply_company_email` | uri → CompanyEmails | Read-only. Sender company email used as the From / Reply-To on schedule confirmation emails. |

Custom fields appear in your space's live spec: `GET /api/v100/rest/spaces/{space_id}/openapi.json` 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.

| 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). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md