Skip to main content
GET
List Pay Group Employees

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

pay_group_id
string
required
organization_id
string
required

Query Parameters

valid_at
string<date> | null

Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.

limit
integer
default:10

Items per page

Required range: 1 <= x <= 100
cursor
string | null

next_cursor of the previous response, for the next page

prev_cursor
string | null

prev_cursor of the previous response, for the page before it. Not together with cursor.

sort
string[]

Fields to order by, - in front for descending (-created_at). Repeat the parameter for more fields. Keep the same sort while following cursors.

Response

Successful Response

items
PayGroupEmployeeSummary · object[]
required
pagination
PaginationMeta · object
required