Developers
V1PartnerTenantsTenantidLeave

HR leave review and operational counts for an authorised corporate workspace

Includes only employee-submitted leave for active members, never drafts or health-passport data. Counts include all non-draft states in the requested date window, independent of the list status filter. Day totals are calendar days overlapping that window, not working days, paid leave or remaining entitlement.

GET
/v1/partner/tenants/{tenantId}/leave
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

limit?integer
Range1 <= value <= 100
Default30
cursor?string
Lengthlength <= 512
status?string

Value in

  • "submitted"
  • "approved"
  • "rejected"
  • "withdrawn"
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

Response Body

application/json

curl -X GET "https://example.com/v1/partner/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/leave?from=2019-08-24&to=2019-08-24"
{  "requests": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",      "tenantName": "string",      "startDate": "2019-08-24",      "endDate": "2019-08-24",      "note": "",      "certificateReference": "",      "calendarDays": 1,      "status": "draft",      "createdAt": "2019-08-24T14:15:22Z",      "submittedAt": "2019-08-24T14:15:22Z",      "consent": {        "version": "2026-09-09",        "grantedAt": "2019-08-24T14:15:22Z"      },      "history": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "action": "submitted",          "actor": "employee",          "note": "string",          "at": "2019-08-24T14:15:22Z"        }      ],      "certificate": {        "mimeType": "image/jpeg",        "expiresAt": "2019-08-24T14:15:22Z"      },      "employeeId": "b0e78c8f-8c8b-4410-8293-9239e39d9e17",      "employeeEmail": "string",      "canDecide": true    }  ],  "nextCursor": "string",  "analytics": {    "from": "2019-08-24",    "to": "2019-08-24",    "counts": {      "submitted": 0,      "approved": 0,      "rejected": 0,      "withdrawn": 0    },    "submittedCalendarDays": 0,    "approvedCalendarDays": 0  }}