HomeBook an Intro CallStartup Program
API Endpoints

List locations

get
https://api-stage.onsched.com/v3/locations

Retrieve a paginated list of locations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
services
array of strings

Filter locations by service IDs

services
resources
array of strings

Filter locations by resource IDs

resources
string

Filter locations by exact CustomFields key/value match. Use dot notation, for example CustomFields.regionCode=east-1. Multiple CustomFields parameters are combined with AND. Not supported on GET /v3/public/locations.

integer
≤ 500
Defaults to 20

Limit the number of locations returned

integer
Defaults to 1

Page number

string

Comma-separated relations to eager-load. When omitted, list returns serviceIds/resourceIds instead of full Services/Resources. Allowed values include services, resources.

Responses

400

Invalid query parameters, or malformed CustomFields.<key> filter.

401

Unauthorized

403

Forbidden

Updated 4 months ago

Did this page help you?
Language
Credentials
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?