Application object

compliance

object

required

compliance.gdpr

object

compliance.gdpr.consent_requests

object[]

required

A list of any GDPR consent extensions requests.

compliance.gdpr.consent_requests.expires_at

string

The date the request expires at

compliance.gdpr.consent_requests.sent_at

string

The date the request was sent at

compliance.gdpr.consent_requests.status

enum<string>

The status of the consent request

Available options:

pending,

complete

compliance.gdpr.consent_expires_at

string | null

stage

object

required

The current status of the application.

stage.parent_stage

enum<string>

required

The parent stage of the application. eg Screening, Interviewing

Available options:

rejected,

new,

screening,

interviewing,

offered,

hired

stage.custom_stage

object | null

Optional sub stage. This is a custom stage

stage.custom_stage.id

string

The id of the custom stage, format pipl_abc123

stage.custom_stage.name

string

The name given to this custom stage.

applied_at

string

The date and time of the application in UTC.

candidate

object

The candidate object.

candidate.first_name

string

required

The first name of the candidate.

Minimum length: 1

candidate.last_name

string

required

The last name of the candidate.

Minimum length: 1

candidate.tags

object[]

required

A list of tags applied to the candidate.

candidate.tags.id

string

candidate.tags.name

string

candidate.application_ids

string[]

A list of other application ids this candidate may have. Format app_abc123.

candidate.company

string

The current company of the candidate.

candidate.email

string

The email address of the candidate.

candidate.full_name

string

The full name of the candidate.

candidate.id

string

The id of the candidate, format can_abc123.

candidate.image_url

string

An image url to a profile picture

candidate.location

object

candidate.location.address

string

The city/street address of the candidate.

candidate.location.country

object

candidate.location.country.code

string

The 2 letter ISO country code of the candidate. eg US, FR, ES, IT, IE

candidate.location.country.name

string

The country name of the candidate.

candidate.phone_number

string

The phone number of the candidate.

candidate.rating

integer | null

A 1-5 star rating assigned to the candidate.

candidate.social_profiles

object[]

candidate.social_profiles.type

enum<string>

Available options:

linked_in,

twitter,

facebook,

github,

github_username,

gitlab,

codepen,

dribble,

instagram,

other,

stackoverflow,

personal_site,

behance

candidate.social_profiles.uri

string

candidate.title

string

The current job title of the candidate.

cover_letter

string

The cover letter for this application

feedback

string[]

List of feedback forms ids for this application

string

The id of the application, format app_abc123.

interviews

string[]

List of interview ids for this application

job

object

job.id

string | null

job.title

string

potential_duplicate

boolean

resume

object | null

resume.id

string

resume.original

object

resume.original.content_type

string

resume.original.file_extension

string

resume.original.name

string

resume.original.original_name

string

resume.pdf

object | null

resume.pdf.content_type

string

resume.pdf.file_extension

string

resume.pdf.name

string

resume.pdf.original_name

string

source

object

source.contact

object | null

If details of the referral contact if the application was referred.

source.contact.id

string | null

The id of the contact, format cnt_abc123

source.contact.name

string

The name of the contact.

source.origin

enum<string>

The origin of the application. eg Applied, Added, Submitted by an agency

Available options:

added,

applied,

interested,

referred,

candidate_pool,

hire_hive_import,

agency_submission

source.recruiter

object | null

If details of the external recruiter if the application was submitted via the agency portal.

source.recruiter.id

string

The id of the recruiter, format Guid

source.recruiter.name

string

The name of the recruiter.

source.source

string

The source name. eg Google, LinkedIn

source.user

object | null

If details of the user if the application was added manually.

source.user.id

string | null

The id of the user, format usr_abc123

source.user.name

string

The name of the user.

Getting Started

Endpoints

Webhooks