Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
service

Get a paged array of services

Get a paged array of services

get/services

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

namestring nullable

Service name

Example:Initial Consultation
typestring nullable

Service type

Example:Other
codestring nullable

Service code

Example:ABC123
serviceTagstring nullable

Service tag

Example:NDIS

Response

A paged array of services

Example response

{
  "data": [
    {
      "id": 1,
      "for": "appointment",
      "name": "Initial Consultation",
      "description": "This is a sample service",
      "type": "Other",
      "code": "ABC123",
      "duration": 90,
      "unit": "Hour",
      "pricing": 193.99,
      "serviceTags": [
        "NDIS"
      ]
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}