Actions4
- Group Actions
- Timeoff Actions
Timeoff → List Timeoffs
AI-generatedSummary
Retrieves a paginated list of timeoff requests from the BaseVN system, supporting filtering by user, date ranges, status, and search query.
Inputs
- Page — Page index to request (starts from 0).
- Users — Filter by creator username (comma-separated).
- Additional Fields — Collection of optional filters: End Date From/To, Search Query, Start Date From/To, Status.
Output shape
A list of items, each containing a JSON object of a timeoff record.
The API returns paginated data. Empty fields or filters with empty values are not sent to the API (see utils.cleanBody). The response structure depends on the API's success code.
Examples
Example 1: List all approved timeoffs for a specific user on the first page.
Set Users to 'john.doe', Page to 0, and Additional Fields Status to 'approved'.
Example 2: Search for timeoffs between two dates.
Set Additional Fields Start Date From to '01/01/2024' and End Date To to '31/12/2024'.