BrightHR icon

BrightHR

Interact with BrightHR API

Actions12

Time Off → Get Many

AI-generated

Summary

Retrieve multiple time off requests from BrightHR, optionally limited by the number of results returned.

Inputs

  • Return All — Whether to return all time off requests or only up to the specified limit.
  • Limit — Maximum number of time off requests to return, when Return All is false. Value range: 1 to 100. Default is 50.

Output shape

a list of time off request objects

If Return All is true, all available time off requests are returned; otherwise, the number of returned requests is capped by the Limit parameter.

Examples

Example 1: Fetch all time off requests without limiting the number of results by enabling Return All.

Set 'Return All' to true; 'Limit' parameter is ignored.

Example 2: Fetch up to 20 time off requests.

Set 'Return All' to false; set 'Limit' to 20.

Discussion