--- title: "List Appointments" method: GET path: "/locations/{location_id}/appointments" tags: ["Appointments"] --- # List Appointments `GET /locations/{location_id}/appointments` Retrieve Appointments for a Location as JSON:API resource objects. Pagination uses `page` and `limit`. The response includes the effective `page`, calculated `offset`, and `limit` in `meta.pagination`. Date range values use `YYYY-MM-DDTHH:MM:SS` without a timezone. Provide `filter[date_intersect_from]` and `filter[date_intersect_to]` together; the end must be later than the start. Related data can be requested by repeating the `include` parameter. Wire values remain literal API keys: `client` identifies Booking User data, `staff` identifies Team Member data, and `goods` identifies Products. Custom Field Value includes require the corresponding Business User permissions. ## Path parameters - `location_id` integer, required ## Query parameters - `filter[client_id]` integer - `filter[activity_id]` integer - `filter[date_intersect_from]` string - `filter[date_intersect_to]` string - `page` integer - `limit` integer - `include` string[] ## Headers - `Accept` string, required - `Authorization` string, required ## Response `200` Appointments retrieved successfully - object - `data` AppointmentResource[], required - `type` 'record', required — Literal JSON:API resource type - `id` string, required — Appointment ID - `attributes` object, required - `company_id` integer, required — Location ID - `external_id` string, required — External Appointment ID - `visit_id` integer, required — Linked visit ID, or `0` when not linked - `booking_user_id` integer, required — Booking User account ID, or `0` - `bookform_id` integer, required — Booking form ID, or `0` - `master_id` integer, required — Deprecated wire field for Team Member ID; use `staff_id` - `staff_id` integer, required — Team Member ID - `client_id` integer, required — Booking User profile ID, or `0` when absent - `comer_id` integer, nullable, required — Walk-in visitor ID - `source` integer, required — Appointment source wire value - `attendance` -1 | 0 | 1 | 2, required — Deprecated attendance wire value; use `attendance_status_slug` - `attendance_status` -1 | 0 | 1 | 2, required — Deprecated attendance status; use `attendance_status_slug` - `attendance_status_slug` 'absent' | 'waiting' | 'attended' | 'confirmed', required — Appointment attendance status - `client_fictive_name` string, nullable, required — Fallback Booking User name stored on the Appointment - `client_fictive_phone` string, nullable, required — Fallback Booking User phone stored on the Appointment - `client_fictive_email` string, nullable, required — Fallback Booking User email stored on the Appointment - `clients_count` integer, required — Number of Booking Users in the Appointment - `activity_id` integer, required — Event ID, or `0` when the Appointment is not part of an Event - `custom_color` string, required — Appointment background color without `#`, or an empty string - `custom_font_color` string, required — Appointment text color without `#`, or an empty string - `length` integer, required — Deprecated duration in seconds; use `duration` - `duration` integer, required — Appointment duration in seconds - `paid_full` 0 | 1 | 2, required — Deprecated payment wire value; use `is_paid` and `is_overpaid` - `is_paid` boolean, required — Whether the Appointment is fully paid - `is_overpaid` boolean, required — Whether the Appointment is overpaid - `timestamp` integer, required — Appointment start as a Unix timestamp - `date` string, required — Appointment start in the Location timezone, without an offset - `created_datetime` string, required — Creation date and time in the Location timezone, without an offset - `from_url` string, required — Source URL, or an empty string - `is_mobile` integer, required — Mobile-origin wire status - `comment` string, required — Appointment comment - `prepaid_status` integer, required — Prepayment status wire value - `record_from` string, required — Human-readable Appointment source, or an empty string - `payment_status` integer, nullable, required — Membership auto-payment status, when available - `is_sale_bill_printed` boolean, nullable, required — Whether the sale bill is printed, when available - `is_client_notification_sent` boolean, required — Whether a Booking User notification was sent - `relationships` object — Present when related data is requested through `include` - `client` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `staff` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `services` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `goods` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `resource_instances` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `labels` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `attendance_service_items` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `attendance_good_items` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `attendance_document` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `transactions` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `fast_payment_settings` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `acceptance_free` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `custom_field_values` ToManyRelationship - `data` ResourceIdentifier[], required - `type` string, required - `id` string, required - `comer` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `client_notification_settings` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `client_schedule` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `duration_details` ToOneRelationship - `data` ResourceIdentifier, required - `type` string, required - `id` string, required - `included` IncludedResource[] — Resources requested through `include`, when available - `type` string, required - `id` string, required - `attributes` object, required - `relationships` object - `meta` object, required - `pagination` Pagination, required - `page` integer, required - `offset` integer, required - `limit` integer, required ## Other responses - `401` — Unauthorized - `403` — Forbidden - No permission to read Appointments for this Location - `404` — Location not found - `422` — Invalid filter or pagination value --- [API](https://skmtc.net/alteg/apis/business-management.md) · [All operations](https://skmtc.net/alteg/apis/business-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alteg/business-management/revisions/bc9cbcc9c5f1/schema)