v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Booking tickets

Get all booking tickets

Get a list of all booking tickets. A booking ticket defines a type of bookable resource or service - for example, a therapist, a consultation room, or an event. Use filters such as customer_id, validity range, or ticket properties to narrow results.

get/booking-tickets

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

customer_idstring

The unique ID of the customer. GET /customers

valid_fromstring

Start of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

valid_tostring

End of the validity period for filtering. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

valid_onlytrue | false

Time validity of the resource records. Possible values are: true - returns only records valid in current moment / false - returns all records of the resource without time validation

booking_ticket_property_idstring

Booking ticket property ID from resource booking-ticket-properties. The parameter determines property, which is used to filter resources by their properties. The parameter must be used in combination with property_value otherwise is ignored in the request.

booking_ticket_property_valuestring

Booking ticket property record value from booking-ticket-properties in case of datatype with multiple values. Parameter filters resources depends of store property record value. The parameter must be used in combination with property_id otherwise is ignored in the request.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "booking_tickets": [
      {
        "ticket_id": "89d88719b8b442de2d11b401a2",
        "name": "Prophecy",
        "created_at": "2022-07-26 11:38:22",
        "state": 1,
        "last_change": "2022-09-16 16:14:41"
      }
    ],
    "total_items": 1
  }
}