PeopleForce
Leaves

List leave requests

GET
/api/public/v3/leave_requests

Query Parameters

created_at[gt]?integer

Unix epoch seconds

created_at[lt]?integer

Unix epoch seconds

employee_id?integer
employee_ids[]?array<integer>
ends_on?string
Formatdate
starts_on?string
Formatdate
states[]?array<string>
updated_at[gt]?integer

Unix epoch seconds

updated_at[lt]?integer

Unix epoch seconds

Response Body

application/json

curl -X GET "https://example.com/api/public/v3/leave_requests"
{  "data": [    {      "id": 0,      "employee_id": 0,      "leave_type_id": 0,      "leave_type": "string",      "state": "pending",      "amount": "string",      "hours": "string",      "tracking_time_in": "hours",      "on_demand": true,      "starts_on": "string",      "ends_on": "string",      "comment": "string",      "created_at": "string",      "updated_at": "string",      "attachment_url": null,      "attachments": [        null      ],      "employee": {        "id": 0,        "first_name": "string",        "last_name": "string",        "email": "string"      },      "entries": [        {          "date": "string",          "amount": "string",          "starts_at": null,          "ends_at": null        }      ],      "leave_type_policy": {        "name": "string",        "visibility": "public",        "activity_type": "not_working_paid"      },      "approvals": [        {          "state": "queued",          "assigned_to": {            "id": 0,            "full_name": "string"          }        }      ]    }  ],  "metadata": {    "pagination": {      "page": 0,      "pages": 0,      "count": 0,      "items": 0    }  }}