v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Onboarding Tasks

Returns the onboarding tasks assigned to a specified talent.

get/v1/talent/{talentId}/talent-onboarding-tasks

Path parameters

talentIdstring required

An identifier for the talent whose onboarding tasks 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 list of onboarding tasks assigned to the specified talent.

taskNamestring

The Name for a talent onboarding task.

statestring

The State or Status for a talent onboarding task. Valid values are Assigned, Initiated, VerificationRequired, Completed, Rejected, Deleted, OverDue.

Example response

[
  {
    "taskName": "Clerical Questionnaire",
    "state": "Completed"
  }
]