v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Partner References

Get Partner Talent Benefit References

Returns key-value pairs of all Reference Groups and Reference Options for a specified talent. The authenticated API requestor must be a Talent Benefit partner; otherwise, an error is returned.

get/v1/partner-reference/talent-benefits/{talentId}

Path parameters

talentIdstring required

The identifier for the talent whose benefit partner references are being retrieved.

Headers

RequestIdstring uuid

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

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

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

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

A list of benefit partner references for the specified talent.

referenceKeystring required

The name of the reference group.

referenceValuestring required

The reference value.