Batch Record List

Retrieves workforce records associated with a specific batch.

Provide the batch_id as a path parameter to fetch records for a specific batch. Use query parameters to filter records by updated_at.

Typical use-cases:

  • Retrieve all employee records added to a batch.
  • Filter records by the updated_at timestamp.
  • Audit or troubleshoot batch processing results.

Supports pagination via limit and offset query parameters for efficient handling of large datasets.

us-east-2 eu-west-2 ap-southeast-2 ca-central-1 eu-central-1 ap-southeast-1

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier for the batch.

Query Params
integer
0 to 50
Defaults to 50

Maximum number of records per page.
Example: 50

integer
≥ 0
Defaults to 0

Index of the first record to return.
Example: 0

date-time

Filter for records updated at or after this date-time.
Example: 2025-03-15T12:00:00.000Z

date-time

Filter for records updated at or before this date-time.
Example: 2025-03-17T12:00:00.000Z

Responses

400

Invalid request data

401

Unauthorized

404

Batch not found

500

Internal server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json