GET /consumer/v1/services

onsched.com:consumer

Summary: List Services
Operation ID: —
Auth: unknown
Description

<p>Use this endpoint to <b>List Services</b> 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.</p>

Parameters (11)

allLocations (boolean, query, optional)

Search All Locations, default is false

defaultService (boolean, query, optional)

Filter by default service, default is false

limit (integer, query, optional)

Page limit default 20, max 100

locationId (string, query, optional)

id of business location, defaults to primary business location

name (string, query, optional)

Filter by Name, supports Partial name search

offset (integer, query, optional)

Starting row of page, default 0

scope (?, query, optional)

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

serviceGroupId (integer, query, optional)

Filter by groupId

serviceId (string, query, optional)

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

sortDescending (boolean, query, optional)

Sort results in Descending Order, default true

sortOrder (?, query, optional)

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

No probe data for this endpoint yet.