Services
Read the services your company offers, with their base price and duration. You'll use a service's ID to book it when creating an inspection.
List services
Returns a paginated list of your company's services. Only your company's services are listed. By default the list holds every service, each carrying its own hidden flag: a hidden service is not offered on the Online Scheduler but your staff can still book it. Pass filter[hidden]=false to list only what the Online Scheduler shows, or filter[hidden]=true to list only the hidden services. Without a sort, services come back in your company's service priority order. You'll use a service's ID to book it when creating an inspection.
query Parameters
page[number]Page number (starts at 1)
page[size]Number of records per page (default: 200, max: 200)
filter[hidden]false lists only the services the Online Scheduler shows; true lists only the hidden ones. Omit it to list every service.
sortSort field. Prefix with '-' for descending order. Supported values: name, priority
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List services › Responses
Services retrieved successfully
Get a service
Returns one of your company's services by ID. Hidden services are returned too, with hidden: true, so a service ID found on an older inspection can still be resolved. A service ID that belongs to another company, and one that matches no service, both answer 404.
path Parameters
idService ID
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get a service › Responses
Service retrieved successfully

