Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Referrals

Returns details about the specified talent's referrals.

get/v1/talent/{talentId}/talent-referrals

Path parameters

talentIdstring required

The identifier for the talent whose referral details 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

The talent's referrals.

talentIdinteger required

The identifier for the talent.

Example response

{
  "talentId": 18394,
  "referredBy": [
    {
      "referralId": 2842,
      "referredById": 167395,
      "referredByName": "Jane Doe",
      "referredByEntityType": "Talent"
    }
  ],
  "referrerOf": [
    {
      "referralId": 1894,
      "referrerOfId": 138952,
      "referrerOfName": "Jane Doe",
      "referrerOfEntityType": "Talent"
    }
  ]
}