Get application

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id

string

required

candidate_id

string

required

application_id

string

required

Response

200 - application/json

data

object

data.compliance

object

required

data.compliance.gdpr

object

data.compliance.gdpr.consent_requests

object[]

required

A list of any GDPR consent extensions requests.

data.compliance.gdpr.consent_requests.expires_at

string

The date the request expires at

data.compliance.gdpr.consent_requests.sent_at

string

The date the request was sent at

data.compliance.gdpr.consent_requests.status

enum<string>

The status of the consent request

Available options:

pending,

complete

data.compliance.gdpr.consent_expires_at

string | null

data.stage

object

required

The current status of the application.

data.stage.parent_stage

enum<string>

required

The parent stage of the application. eg Screening, Interviewing

Available options:

rejected,

new,

screening,

interviewing,

offered,

hired

data.stage.custom_stage

object

Optional sub stage. This is a custom stage

data.stage.custom_stage.id

string

The id of the custom stage, format pipl_abc123

data.stage.custom_stage.name

string

The name given to this custom stage.

data.applied_at

string

The date and time of the application in UTC.

data.candidate

object

The candidate object.

data.candidate.first_name

string

required

The first name of the candidate.

Minimum length: 1

data.candidate.last_name

string

required

The last name of the candidate.

Minimum length: 1

data.candidate.tags

object[]

required

A list of tags applied to the candidate.

data.candidate.tags.id

string

data.candidate.tags.name

string

data.candidate.application_ids

string[]

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

data.candidate.company

string

The current company of the candidate.

data.candidate.email

string

The email address of the candidate.

data.candidate.full_name

string

The full name of the candidate.

data.candidate.id

string

The id of the candidate, format can_abc123.

data.candidate.image_url

string

An image url to a profile picture

data.candidate.location

object

data.candidate.location.address

string

The city/street address of the candidate.

data.candidate.location.country

object

data.candidate.location.country.code

string

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

data.candidate.location.country.name

string

The country name of the candidate.

data.candidate.phone_number

string

The phone number of the candidate.

data.candidate.rating

integer | null

A 1-5 star rating assigned to the candidate.

data.candidate.social_profiles

object[]

data.candidate.social_profiles.type

enum<string>

Available options:

linked_in,

twitter,

facebook,

github,

github_username,

gitlab,

codepen,

dribble,

instagram,

other,

stackoverflow,

personal_site,

behance

data.candidate.social_profiles.uri

string

data.candidate.title

string

The current job title of the candidate.

data.cover_letter

string

The cover letter for this application

data.feedback

string[]

List of feedback forms ids for this application

data.id

string

The id of the application, format app_abc123.

data.interviews

string[]

List of interview ids for this application

data.job

object

data.job.id

string | null

data.job.title

string

data.potential_duplicate

boolean

data.resume

object

data.resume.id

string

data.resume.original

object

data.resume.original.content_type

string

data.resume.original.file_extension

string

data.resume.original.name

string

data.resume.original.original_name

string

data.resume.pdf

object

data.resume.pdf.content_type

string

data.resume.pdf.file_extension

string

data.resume.pdf.name

string

data.resume.pdf.original_name

string

data.source

object

data.source.contact

object

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

data.source.contact.id

string | null

The id of the contact, format cnt_abc123

data.source.contact.name

string

The name of the contact.

data.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

data.source.recruiter

object

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

data.source.recruiter.id

string

The id of the recruiter, format Guid

data.source.recruiter.name

string

The name of the recruiter.

data.source.source

string

The source name. eg Google, LinkedIn

data.source.user

object

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

data.source.user.id

string | null

The id of the user, format usr_abc123

data.source.user.name

string

The name of the user.

Getting Started

Endpoints

Webhooks

Authorizations

Path Parameters

Response