v1

latestOpenAPI 3.0.12026-07-133870165.8 KB

Services

List 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.

get/consumer/v1/services

Query parameters

locationIdstring

id of business location, defaults to primary business location

serviceGroupIdinteger

Filter by groupId

defaultServiceboolean

Filter by default service, default is false

allLocationsboolean

Search All Locations, default is false

scope'company' | 'location' | 'all'

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

namestring

Filter by Name, supports Partial name search

serviceIdstring

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

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

sortOrder'natural' | 'name'

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

sortDescendingboolean

Sort results in Descending Order, default true

Response

Success

objectstring nullable

urlstring nullable

hasMoreboolean

countinteger

totalinteger