Candidate.md

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	str		[optional] [readonly]
remote_id	str, none_type	The third-party API ID of the matching object.	[optional]
first_name	str, none_type	The candidate's first name.	[optional]
last_name	str, none_type	The candidate's last name.	[optional]
company	str, none_type	The candidate's current company.	[optional]
title	str, none_type	The candidate's current title.	[optional]
remote_created_at	datetime, none_type	When the third party's candidate was created.	[optional]
remote_updated_at	datetime, none_type	When the third party's candidate was updated.	[optional]
last_interaction_at	datetime, none_type	When the most recent candidate interaction occurred.	[optional]
is_private	bool, none_type	Whether or not the candidate is private.	[optional]
can_email	bool, none_type	Whether or not the candidate can be emailed.	[optional]
locations	[str, none_type], none_type	The candidate's locations.	[optional]
phone_numbers	[PhoneNumber]		[optional]
email_addresses	[EmailAddress]		[optional]
urls	[Url]		[optional]
tags	[str]	Array of `Tag` names as strings.	[optional]
applications	[str, none_type]	Array of `Application` object IDs.	[optional]
attachments	[str, none_type]	Array of `Attachment` object IDs.	[optional]
remote_data	[RemoteData], none_type		[optional] [readonly]
custom_fields	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type	Custom fields configured for a given model.	[optional]
remote_was_deleted	bool		[optional] [readonly]

[Back to Model list] [Back to API list] [Back to README]