v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
busy-time-type

Get a paged array of busy-time-types

Get a paged array of busy-time-types

get/busy-time-types

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

titlestring nullable

Busy time type title

Example:Meeting
isUtilisationIncludedboolean nullable

Whether this busy time type includes utilisation

Response

A paged array of busy-time-types

Example response

{
  "data": [
    {
      "id": 1,
      "title": "Meeting",
      "color": "#72a2c3",
      "duration": 60,
      "note": "Daily stand-up"
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}