List Services

get

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

Retrieves a list of bookable services.
Results are returned as a paginated list.
duration_unit may be minute, day, or week

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company id

Query Params

page

int32

Defaults to 1

per_page

int32

Defaults to 1000

api_ref

string

reference

string

Allows searching by reference

embed

string

A comma seperated list of resources to embed. Available: company, child_services, images

category_id

int32

Category id

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

queue_id

int32

Filter services belonging to a specific queue

person_id

string

Person id

visibility_types

array of strings

Filter service with different visibility_types

visibility_types

Allowed:

method_of_appointment

string

enum

Filter services by delivery method

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200Services