Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.07 KB

Candidate.md

File metadata and controls

34 lines (26 loc) · 2.07 KB

Candidate

The Candidate Object ### Description The Candidate object is used to represent a Candidate for various positions. ### Usage Example Fetch from the LIST Candidates endpoint and filter by ID to show all candidates.

Properties

Name Type Description Notes
id UUID [optional] [readonly]
remoteId String The third-party API ID of the matching object. [optional]
firstName String The candidate's first name. [optional]
lastName String The candidate's last name. [optional]
company String The candidate's current company. [optional]
title String The candidate's current title. [optional]
remoteCreatedAt OffsetDateTime When the third party's candidate was created. [optional]
remoteUpdatedAt OffsetDateTime When the third party's candidate was updated. [optional]
lastInteractionAt OffsetDateTime When the most recent candidate interaction occurred. [optional]
isPrivate Boolean Whether or not the candidate is private. [optional]
canEmail Boolean Whether or not the candidate can be emailed. [optional]
locations List<String> The candidate's locations. [optional]
phoneNumbers List<PhoneNumber> [optional]
emailAddresses List<EmailAddress> [optional]
urls List<Url> [optional]
tags List<String> Array of `Tag` names as strings. [optional]
applications List<UUID> Array of `Application` object IDs. [optional]
attachments List<UUID> Array of `Attachment` object IDs. [optional]
remoteData List<RemoteData> [optional] [readonly]
remoteWasDeleted Boolean [optional] [readonly]
fieldMappings Map<String, Object> [optional] [readonly]