Get Entity Reference by ID

get

https://api.avionte.com/back-office/v2/entity-reference/{entityType}/{idType}/{id}

Returns related BOLD and Back Office entity ID for a variety of entity types.

Path Params

entityType

string

required

The entity type to search for. Accepts one of the following values: Employer, Talent, Company, CompanyDepartment, Job, Placement, or ConfigTransactionType.

idType

string

required

The type of ID to search for. Accepts Bold or BackOffice.

string

required

The identifier to search for. If idType is Bold, pass the Bold ID. If it is BackOffice, pass the BackOffice ID. If entityType is Talent, provide either a Talent GUID or a BackOffice ID.

Headers

Tenant

string

Tenant company code for scoped data access during the request.

FrontOfficeTenantId

integer

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

RequestId

uuid

required

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

Responses

400

Bad Request

401

Unauthorized

403

Access Denied

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response

404Not found