Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Paid Talent

Returns a paginated list of talent GUIDs with positive total wages within the provided date range.

post/v1/talent/paid-talent

Query parameters

pageinteger

The page number to retrieve in the paginated response.

pageSizeinteger

The number of items to include per page in the paginated response.

Headers

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

An integer identifier for the tenant which the request is being made for. Required when the Tenant header is not provided.

RequestIdstring uuid required

The unique request identifier used to correlate request data to log entries and events, formatted as a UUID.

Request body

supplierGuidstring guid required

The unique identifier for the staffing company (supplier), formatted as a UUID.

checkStartDatestring date-time required

The start date of the paycheck date range used to calculate total wages. Provide only the date without any time information, in any valid format (for example, YYYY-MM-DD or MM-DD-YYYY).

checkEndDatestring date-time required

The end date of the paycheck date range used to calculate total wages. Provide only the date without any time information, in any valid format (for example, YYYY-MM-DD or MM-DD-YYYY).

Response

200 response

totalCountinteger required

The total number of items.

resultsstring[]
pageSizeinteger

The number of items to be displayed on one page.

currentPageinteger

The current page number.

totalPagesinteger

The total number of pages.