Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Placements

Get Placements by Talent ID

Returns placements for a talent.

get/v1/talent/{talentId}/placement/{page}/{pageSize}

Path parameters

pagestring required

The page number to retrieve. The minimum value is 1.

pageSizestring required

The page size to retrieve. The minimum value is 1, the maximum value is 100.

talentIdstring required

The unique identifier for the talent to retrieve.

Query parameters

fromDatestring

The placement search start date.

toDatestring

The placement search end date.

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 placements details.

idinteger

The identifier for the placement.

talentIdinteger

The identifier for the talent.

jobIdinteger

The identifier for the job.

extensionIdListinteger[]

The list of identifiers for all of the placement extensions for the placement.

originalStartDatestring date-time

The placement original start date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

finalEndDatestring date-time

The placement final end date. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

isActiveboolean

An indication of whether the placement is active or not.

employmentType'Temporary' | 'Permanent'

Employment types available for selection.

frontOfficeIdinteger

The identifier for the placement's home office/branch. It occupies the following position in the Front Office hierarchy: Division → Region → Office/Branch. Refer to the <a href="https://developer.avionte.com/reference/getbranches">Get Branches</a> endpoint to retrieve the ID.

hiredDatestring date-time

The date the talent was hired. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T00:00:00.

endReasonIdinteger

The identifier for the end reason.

endReasonstring

The reason for ending the placement.

enteredByUserIdinteger

The identifier for the user who entered the placement record.

enteredByUserstring

The email of the user who entered the placement record.

recruiterUserIdinteger

The identifier for the recruiter user.

recruiterUserstring

The email of the recruiter user.

createdByUserIdinteger

The identifier for the user who created the placement.

createdDatestring date-time

The date when the placement 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.

originstring

The origin of the placement.

reqEmploymentTypestring

The employment type code for the placement.

reqEmploymentTypeNamestring

The display name of the employment type for the placement.

Example response

[
  {
    "id": 123456,
    "talentId": 789012,
    "jobId": 345678,
    "extensionIdList": [
      901234,
      567890
    ],
    "isActive": true,
    "frontOfficeId": 123,
    "endReasonId": 456,
    "endReason": "Contract completed",
    "enteredByUserId": 78934,
    "enteredByUser": "john.doe@example.com",
    "recruiterUserId": 12345,
    "recruiterUser": "john.doe@example.com",
    "createdByUserId": 67890,
    "origin": "Partner XYZ",
    "reqEmploymentType": "1099",
    "reqEmploymentTypeName": "1099 Contractor",
    "approvers": [
      {
        "extensionId": 901234,
        "approverUserId": 78934,
        "approverEntityId": 78934,
        "approverEntityType": "HCM User",
        "approverType": "Both"
      }
    ]
  }
]