Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
support-item

Get a paged array of support-items

Get a paged array of support-items

get/support-items

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

appointmentIdinteger nullable

Appointment id of the support items

Response

A paged array of support-items

Example response

{
  "data": [
    {
      "id": 1,
      "appointmentId": 1,
      "type": "Provider Travel",
      "pricing": 193.99,
      "toMinutes": 20,
      "returnMinutes": 20,
      "appointmentAddress": "123 King William Street, Adelaide SA, 5000",
      "unit": "km",
      "note": "Some notes"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}