v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get a Talent Task

Returns task details for the specified talent task record.

get/v1/talent/task/{taskId}

Path parameters

taskIdstring required

The identifier for the talent task to retrieve.

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 requested talent task.

talentIdinteger

The identifier for the talent.

taskIdinteger

The identifier for the task.

taskTypeIdinteger

The identifier for the task type.

taskTypestring

The name of the task type.

createDatestring date-time

The date the task was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

taskDatestring date-time

The UTC date-time the task was started. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.

startTimestring date-time

The UTC date-time the task was started. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.

endTimestring date-time

The UTC date-time the task was completed. The field follows the YYYY-MM-DDTHH:mm:ss format in UTC time, for example, 2024-12-01T14:30:00Z.

timeZoneIdstring

The timezone location of the task.

taskUserIdinteger

The identifier for the user that created the task.

taskNotesstring

The description of the task.

Example response

{
  "talentId": 292918,
  "taskId": 592845,
  "taskTypeId": 2846,
  "taskType": "Review Company Handbook",
  "timeZoneId": "Central Standard Time",
  "taskUserId": 13459,
  "taskNotes": "Please review the company handbook and sign the acknowledgement page."
}