v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Reference

Get Entity Reference by ID

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

get/v2/entity-reference/{entityType}/{idType}/{id}

Path parameters

entityTypestring required

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

idTypestring required

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

idstring 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

Tenantstring

Tenant company code for scoped data access during the request.

FrontOfficeTenantIdinteger

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

RequestIdstring uuid required

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

Response

200 response

boldIdstring

The BOLD identifier for the entity.

backOfficeIdstring

The Back Office identifier for the entity.

backOfficeUuidstring guid

The unique identifier for an entity in the Back Office, representing the primary key when the key value is a GUID.

entityTypestring

The BOLD Entity type for the entity.