--- title: "AppointmentSchedules.get" method: GET path: "/entities/AppointmentSchedules/{id}" tags: ["Activity"] --- # AppointmentSchedules.get `GET /entities/AppointmentSchedules/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/AppointmentSchedules/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the AppointmentSchedule record with the given id. ## Path parameters - `id` string, uuid, required ## Query parameters - `expand` string ## Response `200` The AppointmentSchedule record. - object - `success` boolean: True when the request succeeded; false on error. - `data` AppointmentSchedule: Online booking link through which people book appointments with a user in the time slots the user has available. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `appointment_owner` string, uri, required: User assigned as the appointment owner when a booking is made through this schedule. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `appointment_type` string, uri, required: Appointment type used when a booking is created. Related AppointmentType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AppointmentType' for its fields. - `owner` string, uri, required: Owner of the schedule (typically the team member whose availability is exposed). Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `reply_company_email` string, uri: Sender company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. Related CompanyEmail record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CompanyEmail' for its fields. - `appointment_description` string, required: Description applied to appointments booked through this schedule. - `appointment_duration` number, double: Duration of each booked appointment. - `appointment_location` string, required: Location applied to appointments booked through this schedule. - `appointment_location_type` 0 | 1 | 2: Where booked appointments take place: the location given in appointment_location (Custom), or a Microsoft Teams (Microsoft) or Zoom (Zoom) online meeting. Integer enum value: 0 - Custom, 1 - Microsoft, 2 - Zoom - `appointment_owner_id` string, uuid, required: Id of the user receiving the booking. - `appointment_subject` string, required: Subject applied to appointments booked through this schedule. - `appointment_subject_uses_schedule_name` boolean, required: When true, booked appointments use the schedule_name as their subject instead of appointment_subject. - `appointment_type_id` string, uuid, required: Id of the appointment type used for appointments booked through the schedule. - `availability_tzid` string: IANA timezone (e.g. "Europe/Bratislava") in which availability windows are defined. - `buffer_time_after` integer, required: Buffer in seconds kept free after each booked appointment (e.g. 900 = 15 minutes). - `buffer_time_before` integer, required: Buffer in seconds kept free before each booked appointment (e.g. 900 = 15 minutes). - `confirmation_page_type` 0 | 1: What is shown to the booker after confirming (e.g. default Coevera page or a custom redirect URL). Integer enum value: 0 - ConfirmationPage, 1 - ExternalUrl - `confirmation_page_url` string: Custom URL the booker is redirected to after confirming. Used when confirmation_page_type selects a custom redirect. - `is_enabled` boolean, required: Master switch for the schedule. Disabled schedules do not accept new bookings. - `minimum_notice_time` integer, required: Minimum notice in seconds required before a slot can be booked (e.g. 3600 = one hour). - `name` string, required: Admin-only name for the schedule, used in pickers and lists. Not shown to bookers; use schedule_name for the public-facing name. - `owner_id` string, uuid, required: Id of the schedule owner. - `planning_day_offset` integer, required: With Offset planning, how many days ahead the schedule remains bookable. - `planning_period_from` string, date: With Period planning, first date bookings are accepted for. - `planning_period_to` string, date: With Period planning, last date bookings are accepted for. - `planning_type` 0 | 1 | 2: 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 and planning_period_to (Period). Integer enum value: 0 - Infinite, 1 - Offset, 2 - Period - `reminder_email_enabled` boolean, required: True when a reminder email is sent to invitees ahead of the booked appointment. - `reminder_email_offset` integer, required: Time before the appointment when the reminder email is sent. Interpreted using reminder_email_offset_type. - `reminder_email_offset_type` 0 | 1 | 2 | 3: Time unit of reminder_email_offset: Minute, Hour, Day or Week. Integer enum value: 0 - Minute, 1 - Hour, 2 - Day, 3 - Week - `reply_company_email_id` string, uuid: Id of the company email used as the From / Reply-To on schedule confirmation emails. Empty falls back to the team space default. - `schedule_name` string, required: Public-facing name of the schedule, shown to bookers on the booking page. - `time_increment` integer, required: Step in seconds between offered start times (e.g. 900 means slots at :00, :15, :30, :45). - `type` 0 | 1: Kind of meetings booked through the schedule: one-to-one (OneToOne) or group (Group) meetings. Integer enum value: 0 - OneToOne, 1 - Group - `url` string, required: Public URL slug of the schedule, used to share the booking page. - `additional_fields_data` object[], required: Custom fields the booker is asked to fill in on the booking page, in display order. - `field_id` string, uuid, required: Id of the appointment field the booker fills in; the value is saved on the booked appointment. - `label` string, required: Label of the field on the booking page. - `is_required` boolean, required: True when the booker must fill in the field. - `availability_data` object, required: Weekly availability windows (per weekday) used to compute bookable slots, in the schedule's availability_tzid timezone. - `appointment_invitees_data` object[], required: Default invitees added to appointments booked through this schedule (Coevera users or external email addresses). - `entity_id` string, uuid: Id of the user or contact; empty for an Email invitee. - `email` string, required: Email address of the invitee. - `type` 1 | 2 | 3, required: Kind of invitee: a Coevera user (Client), a contact (Contact) or an external email address (Email). Only Client invitees are added to booked appointments. Integer enum value: 1 - Client, 2 - Contact, 3 - Email ## Other responses - `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). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)