These docs are for v1.0. Click to read the latest docs for v3-prod.

List Service Allocations

Use this endpoint to return a List of Service Allocations for a specified service. A valid service id is required. Service allocations are used for Event type services only where the events are offered on specific dates and times. Retrieve all allocations for a location by passing in 0 as the service id.

The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

id of service to list allocations for, 0 for all

Query Params
string

The id of the location. Defaults to the primary location

string

The id of the resource to filter on

date-time

Format YYYY-MM-DD. Filter appointments by on/after startDate

date-time

Format YYYY-MM-DD. Filter appointments on/before endDate

int32

Starting row of page, default 0

int32

Page limit default 20, max 100

Responses

400

Missing or invalid values in the request

401

Authorization error.

404

Service was not found

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json