Native booking appointments api

List appointments

Returns the site's appointments, narrowed by any combination of the query parameters (status, attendee email, appointment type, staff member, and start/end/created/updated date ranges) and ordered by the sort_* parameters. Results are paginated: limit defaults to and is capped at 100, offset defaults to 0, and total_responses reports how many appointments match the filters across all pages, not how many are in this one - use it to decide whether to fetch another page.

get/api/sites/multiscreen/{site_name}/booking/appointments

Request

  • Base URL
    https://api.duda.co
  • URL
    https://api.duda.co/api/sites/multiscreen/{site_name}/booking/appointments
  • Auth
    HTTP basic

Path parameters

site_namestring required

The site's unique name (its ID), returned when the site is created.

Query parameters

limitinteger

Maximum number of results to return.

offsetinteger

Number of results to skip.

statusstring[]

Filter appointments by status.

attendee_emailstring

Filter appointments by attendee email.

appointment_uidstring

Filter appointments by booking unique identifier.

appointment_typesstring[]

Filter appointments by appointment type identifiers.

after_startstring

Filter appointments with start after this date string.

before_endstring

Filter bookings with end before this date string.

after_created_atstring

Filter bookings that have been created after this date string.

before_created_atstring

Filter bookings that have been created before this date string.

after_updated_atstring

Filter bookings that have been updated after this date string.

before_updated_atstring

Filter bookings that have been updated before this date string.

sort_startstring

Sort results by their start time in ascending or descending order. Available options: asc, desc

sort_endstring

Sort results by their end time in ascending or descending order. Available options: asc, desc

sort_createdstring

Sort results by their creation time (when booking was made) in ascending or descending order. Available options: asc, desc

sort_updated_atstring

Sort results by their updated time (for example when booking status changes) in ascending or descending order. Available options: asc, desc

staff_member_idsstring[]

Filter appointments by staff member identifiers.

Response

OK

limitinteger

Page size applied for request

offsetinteger

Offset applied for request

site_namestring

Owning site

total_responsesinteger

Total amount of elements matching requested filters

Example response

{
  "results": [
    {
      "appointment_type": {
        "id": "2660601",
        "slug": "sample-event"
      },
      "attendees": [
        {
          "absent": false,
          "email": "user@multiscreensite.com",
          "language": "en",
          "name": "Default",
          "timeZone": "Asia/Jerusalem"
        }
      ],
      "booking_fields_responses": {
        "email": "user@multiscreensite.com",
        "guests": [],
        "name": "Default"
      },
      "cancellation_reason": "Schedule conflict",
      "cancelled_by_email": "user@multiscreensite.com",
      "created_at": "2025-06-16T14:31:58.794Z",
      "duration": 30,
      "end": "2025-06-16T18:00:00.000Z",
      "hosts": [
        {
          "email": "staffmember1@multiscreensite.com",
          "id": "1582498",
          "name": "Staff Member 1",
          "time_zone": "Asia/Jerusalem",
          "username": "staffmember1-example-com"
        }
      ],
      "ics_uid": "kko1gv8tFZe8JjpCpct5tG@duda.co",
      "id": 8589828,
      "location": "https://app.example.com/video/kko1gv8tFZe8JjpCpct5tG",
      "metadata": {
        "pricingType": "FREE",
        "source": "qa-test"
      },
      "rating": 5,
      "recurring_booking_uid": "rec_kko1gv8tFZe8JjpCpct5tG",
      "rescheduled_by_email": "user@multiscreensite.com",
      "rescheduled_from_uid": "abc123defGHIjkl456MNO",
      "rescheduling_reason": "Availability changed",
      "start": "2025-06-16T17:30:00.000Z",
      "status": "accepted",
      "title": "Sample Event between Staff Member 1 and Default",
      "uid": "kko1gv8tFZe8JjpCpct5tG",
      "updated_at": "2025-06-16T14:31:59.219Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.