List Services

get

https://{api_url}/api/v5/admin/{company_id}/services

Retrieves a list of bookable services.
Results are returned in a paginated list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

int32

required

Company id

Query Params

page

int32

Defaults to 1

per_page

int32

Defaults to 1000

reference

string

Filter by custom reference

availability

array of strings

Valid Statuses: 0 - Appointment based services, 1 - One off or regular events and courses, 4 - Queue only services

availability

Allowed:

queuing_disabled

boolean

Filter queueable services

person_id

string

Person id

exclude_disabled

boolean

Excludes disabled services

visibility_types

array of strings

Filter service with different visibility_types

visibility_types

Allowed:

name_contains

string

Filter services by name (case-insensitive contains match)

service_booking_types[enabled_for_appointments]

boolean

When true, include only services that support appointments

service_booking_types[enabled_for_events]

boolean

When true, include only services that support events

service_booking_types[enabled_for_queuing]

boolean

When true, include only services that support queuing

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Services