---
title: "Search Client Bookings"
method: GET
path: "/clients/{client_id}/appointments/bookings/search"
tags: ["Appointment Bookings"]
---

# Search Client Bookings

`GET /clients/{client_id}/appointments/bookings/search`

Returns a list of Appointment Bookings for a Client, given a search query.

## Path parameters

- `client_id` integer, required

## Query parameters

- `sort` string
- `page` integer
- `page_size` integer
- `q` string, required

## Headers

- `x-api-key` string, required

## Response `200`

paginated response of a client's appointment bookings

- ResponseClientAppointmentBookings — List of Client Appointment Bookings
  - `client_appointment_bookings` ClientAppointmentBookingsResponse[] — List of Client Appointment Bookings.
    - `booking_id` integer — Reservation Id (Identifier)
    - `client_id` integer — Client Id
    - `client` string — Client's Name
    - `appointment_id` integer — Appointment Id (Identifier)
    - `utc_appointment_start_datetime` string, date-time — Date Time that the Appointment Starts (UTC)
    - `utc_appointment_end_datetime` string, date-time — Date Time that the appointment ends (UTC)
    - `local_appointment_start_datetime` string, date-time — Date Time that the Appointment Starts (Local)
    - `local_appointment_end_datetime` string, date-time — Date Time that the appointment ends (Local)
    - `service_id` string — Service Id (Identifier)
    - `service` string — Appointment Service Name
    - `location_id` integer — Location Id (Identifier)
    - `location_name` string — Appointment Location Name
    - `provider_id` string — Service Provider Id (User Identifier)
    - `provider` string — Service Provider Name
    - `booking_status_id` integer — Booking's Status Id (Identifier)
    - `booking_status` string — Booking's Status
    - `created` Created — Record creation data.
      - `created_by_id` integer — Unique ID of the user that created the record.
      - `created_by` string — Name of the user that created the record.
      - `created_on_datetime` string, date-time — Datetime on which the record was created.
    - `updated` Updated — Update info
      - `updated_by_id` integer — Unique ID of the user that last updated the record.
      - `updated_by` string — Name of the user that most recently updated the record.
      - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
    - `membership_id` integer — Membership Id associated to the Bookings Appointment
    - `membership` string — Name of the Membership associated to the Booking's Appointment
    - `is_free_trial` boolean — Indicates if the Booking is a Free Trial
    - `is_late_cancellation` boolean — Indicates if the Booking is a Free Trial
    - `cancelled` BookingCancelled2 — Appointment Cancelled By data
      - `cancelled_by_id` integer — Cancelled By (Id)
      - `cancelled_by` string — Cancelled By (Name)
      - `cancelled_on_datetime` string, date-time — Datetime Appointment was cancelled
  - `pagination` Pagination — Pagination for API method responses.
    - `page` integer, required — Current page number.
    - `page_size` integer, required — Number of records per page.
    - `has_more` boolean, required — True if more records exist beyond the current page.
  - `wodify_validation_result` string — The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions: - an UserException with Abort Transaction = Yes, and a Log Error = No - an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)