List Services

get

https://sandbox-api.onsched.com/consumer/v1/services

Use this endpoint to List Services available at your business location and/or company. If not specified, the business location defaults to the primary business location. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

locationId

string

id of business location, defaults to primary business location

serviceGroupId

int32

Filter by groupId

defaultService

boolean

Filter by default service, default is false

allLocations

boolean

Search All Locations, default is false

scope

string

enum

Filter by scope, Company, Location or All, default is All

Allowed:

name

string

Filter by Name, supports Partial name search

serviceId

string

Filter by ServiceId, using this parameter would ignore all other parameters

offset

int32

Starting row of page, default 0

limit

int32

Page limit default 20, max 100

sortOrder

string

enum

Sort results using Natural Sort or Sorted alphabetically by Service Names, default is natural

Allowed:

sortDescending

boolean

Sort results in Descending Order, default true

Response

200Success