Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Contacts

Get a Contact

Returns details about the specified contact.

get/v1/contact/{contactId}

Path parameters

contactIdstring required

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

idinteger

The identifier for the contact.

firstNamestring

The contact's first name.

middleNamestring

The contact's middle name.

lastNamestring

The contact's last name.

workPhonestring

The contact's work phone.

cellPhonestring

The contact's cell phone.

emailAddressstring

The contact's email address.

emailAddress2string

The contact's secondary email address.

address1string

The contact's address, line 1.

address2string

The contact's address, line 2.

citystring

The contact's city.

statestring

The contact's state/province.

postalCodestring

The contact's ZIP/postal code.

countrystring

The contact's country.

linkstring

URL to the contact profile.

companyNamestring

The name of the company.

companyIdinteger

The identifier for the company.

companyDepartmentIdinteger

The identifier for the company department.

titlestring

The contact's title within the organization.

emailOptOutboolean

An indication of whether the contact has opted out of receiving emails from Avionté BOLD or not.

isArchivedboolean

An indication of whether the contact record is archived or not.

representativeUsersinteger[]

The IDs of the Hiring Manager's representatives.

createdDatestring date-time

The date the contact profile was created.

lastUpdatedDatestring date-time

The date of the most recent update to the contact profile.

latestActivityDatestring date-time

The date of the contact's latest activity.

latestActivityNamestring

The contact's latest activity type.

statusstring

The contact's status.

statusTypestring

The contact's status type (Active/Inactive).

originstring

The partner or vendor that originated the request.