Return a list of time-off requests.

get https://sandbox-api.kenjo.io/api/v1/time-off/requests

This endpoint returns a paginated list of time off requests for a given date range.The maximum number of time off requests to retrieve once is 92 days, so the URL params from and to are mandatory. The URL params help to return more accurate results.

Query Params

from

string

required

A date in format YYYY-MM-DD to indicate the starting point. It needs to be equals or less than the to param.

string

required

A date in format YYYY-MM-DD to indicate the ending point. It needs to be equals or greater than the from param.

_userId

string

This field allows to return only the time off requests for a given _userId.

_timeOffTypeId

string

This field allows to filter by time-off type Id.

status

string

This field allows to filter by the time-off request status.

offset

number

Optional filter for pagination proposals. Determines the number of pages to skip when pagination is being used. If this value is not provided, by default the offset will be 1.

limit

number

Optional filter for pagination proposals. The maximum number of rows to retrieve which determines the size of the page. If this value is not provided then the limit will be 50 users. The maximum value of the limit is 100 users per page. Only are valid the following limit values: 25, 50 and 100.

Headers

Authorization

string

required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox-api.kenjo.io/api/v1/time-off/requests \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK.

400BAD REQUEST. This is a wrong request in the client side due to invalid body or params.