v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Paychecks

Get a List of Talent Paychecks

Returns a list of paychecks for the specified talent.

get/v2/talent/paycheck/{applicantId}

Path parameters

applicantIdstring required

The identifier for the talent whose data is being queried.

Query parameters

pageSizestring

The number of records to return per page in a paginated response.

pageNumberstring

The page number to retrieve in a 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.

Response

200 response

totalCountinteger

The total number of items.

pageSizeinteger

The number of items to be displayed on one page.

currentPageinteger

The current page number.

totalPagesinteger

The total number of pages.