Time off

Who’s away

GET
/v1/workspaces/{workspace_id}/timeoff/calendar

Who is away between two dates, as the web app’s wallchart shows it to you: team the people you approve for, everyone all you may see, me you alone (My calendar); group narrows to one department (departments lists them). Every person you may see has a row, away or not, with their department, birthdays and the days they don’t work; what is left in their allowance only where you may see it. Private types show as "Away", with no colour or icon.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.

Path Parameters

workspace_id*string

wsp_…, from GET /v1/me

Lengthlength <= 40

Query Parameters

from*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
scope?string
Default"team"
Value in"team""everyone""me"
group?string

grp_…: one department

Lengthlength <= 40

Response Body

Default Response

application/json
  1. response
from*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
data*array<>
departments*array<>

The departments group can narrow to

curl -X GET 'https://api.sign2approve.com/v1/workspaces/string/timeoff/calendar?from=2019-08-24&to=2019-08-24'
{  "from": "2026-11-09",  "to": "2026-11-13",  "data": [    {      "person_id": "per_01a16d3fd3507be78e41c4540aa20a3c",      "name": "Sam Sender",      "is_me": false,      "department": {        "id": "grp_01a16d3fd3507be78e41c4540aa20a3d",        "name": "Sales"      },      "available": "12.5 days",      "birthdays": [],      "non_working": [],      "days": [        {          "date": "2026-11-09",          "leave_type": "Holiday",          "request_id": "req_01a16d3fd3507be78e41c4540aa20a3c",          "colour": "teal",          "icon": "Palmtree",          "half": null,          "status": "approved"        }      ]    }  ],  "departments": [    {      "id": "grp_01a16d3fd3507be78e41c4540aa20a3d",      "name": "Sales"    }  ]}