v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Roster

Get all roster jobs

Returns a list of all roster jobs for the tenant

get/roster

Query parameters

endAtIdstring

End at document ID, for backward cursor-based pagination

filterstring

Filter criteria. The filter parameter must be URL encoded when sent.

Examples (before URL encoding):

    • Filter by id: {"id":{"eq":"123"}} Example curl commands:
# Filter by id
curl -X GET '<BaseURL>/roster?filter=%7B%22id%22%3A%7B%22eq%22%3A%223%22%7D%7D'

Available filter operations:

  • eq: Equal to
  • neq: Not equal to
  • gt: Greater than
  • gte: Greater than or equal to
  • lt: Less than
  • lte: Less than or equal to
  • in: Value must be one of these (array)
  • nin: Value must not be any of these (array)
  • contains: String contains (case-sensitive, string fields only)

Note: When using the filter parameter in a browser or code, make sure to properly URL encode the JSON string.

pageinteger

Page number (0-based), for offset-based pagination

sizeinteger

Page size

sortBystring

Field to order by. Defaults to 'createdAt'.

sortDirectionstring

Order direction: ASC or DESC. Defaults to 'DESC'.

startAfterIdstring

Start after document ID, for forward cursor-based pagination

Headers

tenant-idstring required

Tenant ID for source type generation

Response

List of roster jobs

totalCountinteger