v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Timeoff > Policy

Reads a single Policy

Reads a single Policy

get/api/2026-07-01/resources/timeoff/policies/{id}

Path parameters

idstring required

The policies ids to retrieve.

Response

OK

idstring required

The policy id.

namestring required

Policy name.

mainboolean

Is the main policy? It will return true if it's the main policy if not it will return false.

company_idstring required

The company id.

descriptionstring

The policy description.

Example response

{
  "id": "1",
  "name": "Policy for remotes",
  "main": true,
  "company_id": "1",
  "description": "This policy will apply only for remote employees"
}