List Slot

get https://{api_url}/api/v5/admin/{company_id}/slots

Retrieves a list of slots.
Results are returned in a paginated list.
You can optionally filter by service, resource and person

Path Params

company_id

string

required

Company id, required, must match Auth-Token company id

Query Params

start_date

string

Start date in ISO-8601 (YYYY-MM-DD), required if no single date

end_date

string

End date in ISO-8601 (YYYY-MM-DD), required if no single date

date

string

Single Date in ISO-8601 (YYYY-MM-DD), required if no start/end date

resource_id

int32

Optionally filter by a single resource id

resource_ids

json

Optionally filter by a multiple resource ids

service_id

int32

Optionally filter by a single service id

person_id

int32

Optionally filter by a single person id

person_ids

json

Optionally filter by a multiple person ids

group_id

int32

Optionally filter by a single group id

include_no_group

boolean

If passing in a group - also include staff and resources with no group assigned

include_booking_details

boolean

includes the bookings made against the slots

include_event_details

boolean

includes the events made against the slots

page

int32

Defaults to 1

per_page

int32

Defaults to 100

Response

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.jrni.com/api/v5/admin/company_id/slots?page=1&per_page=100' \
3
     --header 'accept: application/json'

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

application/json

200Slot Collection