Articles in this section

Available Greenhouse APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt Greenhouse connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Greenhouse API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Activity feed Retrieve activity feed X
Applications List applications X
Retrieve application X
Advance application X
Move application (different job) X
Move application (same job) X
Reject application X
Unreject application X
Update application X
Delete application X
Approvals List approvals for job X
Retrieve approval flow X
Pending approvals for user X
Request approvals X
Replace an approver in an approver group X
Candidates List candidates X
Retrieve candidate X
Add candidate X
Add candidate application X
Add note X
Add education X
Add employment X
Add prospect X
Edit candidate X
Delete candidate X
Remove education from candidate X
Remove employment from candidate X
Merge candidates X
Close reasons List close reasons X
Custom fields List custom fields X
Retrieve custom field X
List custom field options X
Create custom field options X
Update custom field options X
Remove custom field options X
Departments List departments X
Retrieve department X
Add department X
EEOC List EEOC X
Retrieve EEOC data for application X
Education List degrees X
List disciplines X
List schools X
Email templates List email templates X
Retrieve email template X
Job openings List job openings X
Retrieve the information for a single opening X
Create new openings X
Edit openings X
Job posts List job posts for job X
Retrieve job post for job X
Job stages List job stages X
List job stages for job X
Retrieve job stage X
Jobs Retrieve job X
Replace hiring team X
Offers List offers X
List offers for application X
Get current offer for application X
Retrieve offer X
Offices List offices X
Retrieve office X
Add office X
Rejection reasons List rejection reasons X
Scheduled interviews List interviews X
List interviews for application X
Retrieve interview X
Scorecards List scorecards X
List scorecards for application X
Retrieve scorecard X
Sources List sources X
Tags List candidate tags X
List tags applied to candidate X
Add a candidate tag X
Remove tag from candidate X
Tracking links Retrieve tracking link data for token X
Users List users X
Retrieve user X
Add user X
Add e-mail address to user X
User permissions List job permissions X
List future job permissions X
Add a job permission X
Add a future job permission X
Remove a job permission X
Remove a future job permission X
User roles List user roles X
Application stages (v3) List application stages X
Applications (v3) List applications X
Reject application X
Delete application X
Create application X
Convert a prospect to a candidate X
Unreject application X
Update applications X
Mark an application as hire X
Move an application to a different stage within the same job or transfer to another job X
Applied candidate tags (v3) Create applied candidate tag X
List applied candidate tags X
Delete applied candidate tag X
Approval flows (v3) List approval flows X
Create approval flow X
Request approvals X
Update approval flow X
Replace approver groups X
Approver groups (v3) List approver groups X
Replace approver X
Approvers (v3) List approvers X
Attachments (v3) Create attachment X
Delete attachment X
List attachments X
Bulk requests (v3) List bulk requests X
List bulk requests by UUID X
Candidate attribute types (v3) List candidate attribute types X
Candidate educations (v3) Delete candidate education X
Create candidate education X
List candidate educations X
Candidate employments (v3) Create candidate employment X
List candidate employments X
Delete candidate employments X
Candidate tags (v3) Create candidate tag X
List candidate tags X
Delete candidate tags X
Candidates (v3) Create candidate X
Delete candidate X
Anonymize candidates X
List candidates X
Update candidates X
Merge candidates X
Close reasons (v3) List close reasons X
Custom field departments (v3) List custom field departments X
Create custom field department X
Delete custom field department X
Custom field offices (v3) List custom field offices X
Create custom field office X
Delete custom field office X
Custom field options (v3) Create custom field option X
List custom field options X
Update custom field options X
Delete custom field option X
Custom fields (v3) Create custom field X
List custom fields X
Delete custom field X
Update custom fields X
Default interviewers (v3) List default interviewers X
Demographic answer options (v3) List demographic answer options X
Demographic answers (v3) List demographic answers X
Demographic question sets (v3) List demographic question sets X
Demographic questions (v3) List demographic questions X
Departments (v3) List departments X
Create department X
Update department X
EEOC (v3) List eeoc X
Email templates (v3) List email templates X
Focus candidate attributes (v3) List focus candidate attributes X
Future job permissions (v3) List future job permissions X
Create future job permission X
Delete future job permission X
Interview kits (v3) List interview kits X
Interviewer tags (v3) List interviewer tags X
Interviewers (v3) List interviewers X
Interviews (v3) List interviews X
Create interview X
Delete interview X
Update interviews X
Job board custom locations (v3) List job board custom locations X
Job candidate attributes (v3) List job candidate attributes X
Job hiring managers (v3) List job hiring managers X
Create job hiring manager X
Delete job hiring manager X
Job interview stages (v3) List job interview stages X
Job interviews (v3) List job interviews X
Job notes (v3) List job notes X
Create job note X
Delete job note X
Update job notes X
Job owners (v3) List job owners X
Create job owner X
Delete job owner X
Job post locations (v3) List job post locations X
Delete job post location X
Create job post location X
Job posts (v3) List job posts X
Update job post X
Jobs (v3) List jobs X
Create job X
Update job X
Notes (v3) List notes X
Create note X
Offers (v3) List offers X
Create offer X
Update offer X
Offices (v3) List offices X
Create office X
Update office X
Openings (v3) Create opening X
List openings X
Delete openings X
Update openings X
Prospect details (v3) List prospect details X
Prospect pool stages (v3) List prospect pool stages X
Prospect pools (v3) List prospect pools X
Referrers (v3) List referrers X
Rejection details (v3) List rejection details X
Update rejection details X
Rejection reasons (v3) List rejection reasons X
Scorecard candidate attributes (v3) List scorecard candidate attributes X
Scorecard question answer options (v3) List scorecard question answer options X
Scorecard question answers (v3) List scorecard question answers X
Scorecard question candidate attributes (v3) List scorecard question candidate attributes X
Scorecard question options (v3) List scorecard question options X
Scorecard questions (v3) List scorecard questions X
Scorecards (v3) List scorecards X
Sources (v3) List sources X
Tracking links (v3) List tracking links X
User emails (v3) List user emails X
Create user email X
User job permissions (v3) List user job permissions X
Create user job permission X
Delete user job permission X
User roles (v3) List user roles X
Users (v3) List users X
Deactivate user X
Activate user X
Create user X
Revoke user permissions X
Update users X

Available DI objects

The following objects are available when using Greenhouse as a source in Celigo Data Integration (DI).

Primary key: All Greenhouse DI endpoints use id as the primary key, except the EEOC endpoint which keys on application_id. Greenhouse assigns a unique numeric id to each resource object.

Note

Greenhouse hard deletes records. DELETE endpoints physically remove resources (applications, candidates, tags, custom fields, openings) and deleted records are not retrievable via the API; candidates may instead be anonymized in place for GDPR compliance.

Object API endpoint Available extract modes Delta field
Applications (v3) List applications Full, Incremental updated_at
Approval flows (v3) List approval flows Full, Incremental updated_at
Candidate educations (v3) List candidate educations Full, Incremental updated_at
Candidate employments (v3) List candidate employments Full, Incremental updated_at
Candidate tags (v3) List candidate tags Full, Incremental updated_at
Candidates (v3) List candidates Full, Incremental updated_at
Close reasons (v3) List close reasons Full, Incremental updated_at
Custom field options (v3) List custom field options Full, Incremental updated_at
Custom fields (v3) List custom fields Full, Incremental updated_at
Demographic answer options (v3) List demographic answer options Full —
Demographic answers (v3) List demographic answers Full, Incremental updated_at
Demographic question sets (v3) List demographic question sets Full, Incremental updated_at
Demographic questions (v3) List demographic questions Full —
Departments (v3) List departments Full, Incremental updated_at
EEOC (v3) List eeoc Full, Incremental updated_at
Email templates (v3) List email templates Full, Incremental updated_at
Future job permissions (v3) List future job permissions Full, Incremental updated_at
Interviews (v3) List interviews Full, Incremental updated_at
Job posts (v3) List job posts Full, Incremental updated_after
Jobs (v3) List jobs Full, Incremental updated_after
Offers (v3) List offers Full, Incremental updated_at
Offices (v3) List offices Full, Incremental updated_at
Openings (v3) List openings Full, Incremental updated_at
Prospect pools (v3) List prospect pools Full, Incremental updated_at
Rejection reasons (v3) List rejection reasons Full, Incremental updated_at
Scorecards (v3) List scorecards Full, Incremental updated_at
Sources (v3) List sources Full, Incremental updated_at
Tracking links (v3) List tracking links Full, Incremental updated_at
User job permissions (v3) List user job permissions Full, Incremental updated_at
User roles (v3) List user roles Full, Incremental updated_at
Users (v3) List users Full, Incremental updated_at

Response schemas

Click an object below to view its response fields and delta configuration.

Applications (v3) — List applications

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
candidate_id number
prospect boolean
applied_at string
rejected_at string
last_activity_at string
location object
location.address string
source object
source.id number
source.public_name string
credited_to object
credited_to.id number
credited_to.first_name string
credited_to.last_name string
credited_to.name string
credited_to.employee_id string
recruiter object
recruiter.id number
recruiter.first_name string
recruiter.last_name string
recruiter.name string
recruiter.employee_id string
coordinator object
coordinator.id number
coordinator.first_name string
coordinator.last_name string
coordinator.name string
coordinator.employee_id string
rejection_reason object
rejection_reason.id number
rejection_reason.name string
rejection_reason.type object
rejection_reason.type.id number
rejection_reason.type.name string
rejection_details object
rejection_details.custom_fields object
rejection_details.keyed_custom_fields object
jobs objectarray
jobs.id number
jobs.name string
job_post_id number
status string
current_stage object
current_stage.id number
current_stage.name string
answers objectarray
answers.question string
answers.answer string
prospective_office string
prospective_department string
prospect_detail object
prospect_detail.prospect_pool string
prospect_detail.prospect_stage string
prospect_detail.prospect_owner string
custom_fields object
keyed_custom_fields object
attachments objectarray
attachments.filename string
attachments.url string
attachments.type string
attachments.created_at string
Approval flows (v3) — List approval flows

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
offer_id number
sequential boolean
version number
approval_type string
approval_status string
job_id number
requested_by_user_id number
approver_groups objectarray
approver_groups.id number
approver_groups.approvals_required number
approver_groups.created_at string
approver_groups.resolved_at string
approver_groups.priority number
approver_groups.job_id number
approver_groups.offer_id string
approver_groups.approvers objectarray
approver_groups.approvers.id number
approver_groups.approvers.name string
approver_groups.approvers.employee_id string
approver_groups.approvers.email_addresses array
Candidate educations (v3) — List candidate educations

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
school_name string
degree string
discipline string
start_date string
end_date string
Candidate employments (v3) — List candidate employments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
company_name string
title string
start_date string
end_date string
Candidate tags (v3) — List candidate tags

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
Candidates (v3) — List candidates

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
first_name string
last_name string
company string
title string
created_at string
updated_at string
last_activity string
is_private boolean
photo_url string
attachments objectarray
attachments.filename string
attachments.url string
attachments.type string
attachments.created_at string
application_ids array
phone_numbers objectarray
phone_numbers.value string
phone_numbers.type string
addresses objectarray
addresses.value string
addresses.type string
email_addresses objectarray
email_addresses.value string
email_addresses.type string
website_addresses objectarray
website_addresses.value string
website_addresses.type string
social_media_addresses objectarray
social_media_addresses.value string
recruiter object
recruiter.id number
recruiter.first_name string
recruiter.last_name string
recruiter.name string
recruiter.employee_id string
coordinator object
coordinator.id number
coordinator.first_name string
coordinator.last_name string
coordinator.name string
coordinator.employee_id string
can_email boolean
tags array
applications objectarray
applications.id number
applications.candidate_id number
applications.prospect boolean
applications.applied_at string
applications.rejected_at string
applications.last_activity_at string
applications.location object
applications.location.address string
applications.source object
applications.source.id number
applications.source.public_name string
applications.credited_to object
applications.credited_to.id number
applications.credited_to.first_name string
applications.credited_to.last_name string
applications.credited_to.name string
applications.credited_to.employee_id string
applications.recruiter object
applications.recruiter.id number
applications.recruiter.first_name string
applications.recruiter.last_name string
applications.recruiter.name string
applications.recruiter.employee_id string
applications.coordinator object
applications.coordinator.id number
applications.coordinator.first_name string
applications.coordinator.last_name string
applications.coordinator.name string
applications.coordinator.employee_id string
applications.rejection_reason object
applications.rejection_reason.id number
applications.rejection_reason.name string
applications.rejection_reason.type object
applications.rejection_reason.type.id number
applications.rejection_reason.type.name string
applications.rejection_details object
applications.rejection_details.custom_fields object
applications.rejection_details.keyed_custom_fields object
applications.jobs objectarray
applications.jobs.id number
applications.jobs.name string
applications.job_post_id number
applications.status string
applications.current_stage object
applications.current_stage.id number
applications.current_stage.name string
applications.answers objectarray
applications.answers.question string
applications.answers.answer string
applications.prospective_office string
applications.prospective_department string
applications.prospect_detail object
applications.prospect_detail.prospect_pool string
applications.prospect_detail.prospect_stage string
applications.prospect_detail.prospect_owner string
applications.attachments objectarray
applications.attachments.filename string
applications.attachments.url string
applications.attachments.type string
applications.attachments.created_at string
educations objectarray
educations.id number
educations.school_name string
educations.degree string
educations.discipline string
educations.start_date string
educations.end_date string
employments objectarray
employments.id number
employments.company_name string
employments.title string
employments.start_date string
employments.end_date string
linked_user_ids array
custom_fields object
keyed_custom_fields object
Close reasons (v3) — List close reasons

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
Custom field options (v3) — List custom field options

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
priority number
external_id string
Custom fields (v3) — List custom fields

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
field_type string
priority number
value_type string
private boolean
required boolean
require_approval boolean
trigger_new_version boolean
name_key string
description string
expose_in_job_board_api boolean
api_only boolean
offices objectarray
offices.id number
offices.name string
offices.location object
offices.location.name string
offices.primary_contact_user_id string
offices.parent_id string
offices.parent_office_external_id string
offices.child_ids array
offices.child_office_external_ids array
offices.external_id string
departments array
template_token_string string
custom_field_options objectarray
custom_field_options.id number
custom_field_options.name string
custom_field_options.priority number
custom_field_options.external_id string
Demographic answer options (v3) — List demographic answer options

Response schema:

Field Type
id number (Primary key)
free_form boolean
active boolean
name string
demographic_question_id number
translations objectarray
translations.language string
translations.name string
Demographic answers (v3) — List demographic answers

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
free_form_text string
application_id number
demographic_question_id number
demographic_answer_option_id number
created_at string
updated_at string
Demographic question sets (v3) — List demographic question sets

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
title string
description string
active boolean
Demographic questions (v3) — List demographic questions

Response schema:

Field Type
id number (Primary key)
active boolean
demographic_question_set_id number
name string
translations objectarray
translations.language string
translations.name string
required boolean
answer_type string
Departments (v3) — List departments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
parent_id number
parent_department_external_id string
child_ids array
child_department_external_ids array
external_id string
EEOC (v3) — List eeoc

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
application_id number (Primary key)
candidate_id number
race object
race.id number
race.description string
gender object
gender.id number
gender.description string
veteran_status object
veteran_status.id number
veteran_status.message string
disability_status object
disability_status.id number
disability_status.description string
submitted_at string
Email templates (v3) — List email templates

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
description string
default boolean
updated_at string
created_at string
type string
from string
cc array
body string
html_body string
user string
Future job permissions (v3) — List future job permissions

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
office_id number
external_office_id string
department_id number
external_department_id string
user_role_id number
Interviews (v3) — List interviews

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
application_id number
external_event_id string
start object
start.date_time string
end object
end.date_time string
location string
video_conferencing_url string
status string
created_at string
updated_at string
interview object
interview.id number
interview.name string
organizer object
organizer.id number
organizer.first_name string
organizer.last_name string
organizer.name string
organizer.employee_id string
interviewers objectarray
interviewers.id number
interviewers.employee_id string
interviewers.name string
interviewers.email string
interviewers.response_status string
interviewers.scorecard_id number
Job posts (v3) — List job posts

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_after = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
title string
location object
location.id number
location.name string
location.office_id string
location.job_post_custom_location_id number
location.job_post_location_type object
location.job_post_location_type.id number
location.job_post_location_type.name string
internal boolean
external boolean
active boolean
live boolean
first_published_at string
job_id number
content string
internal_content string
updated_at string
created_at string
demographic_question_set_id number
questions objectarray
questions.required boolean
questions.private boolean
questions.label string
questions.name string
questions.type string
questions.values array
questions.description string
Jobs (v3) — List jobs

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_after = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
requisition_id string
notes string
confidential boolean
status string
created_at string
opened_at string
closed_at string
updated_at string
is_template boolean
copied_from_id number
departments objectarray
departments.id number
departments.name string
departments.parent_id number
departments.child_ids array
departments.external_id string
offices objectarray
offices.id number
offices.name string
offices.location object
offices.location.name string
offices.primary_contact_user_id number
offices.parent_id number
offices.child_ids array
offices.external_id string
custom_fields object
keyed_custom_fields object
hiring_team object
hiring_team.hiring_managers objectarray
hiring_team.hiring_managers.id number
hiring_team.hiring_managers.first_name string
hiring_team.hiring_managers.last_name string
hiring_team.hiring_managers.name string
hiring_team.hiring_managers.employee_id string
hiring_team.recruiters objectarray
hiring_team.recruiters.id number
hiring_team.recruiters.first_name string
hiring_team.recruiters.last_name string
hiring_team.recruiters.name string
hiring_team.recruiters.employee_id string
hiring_team.recruiters.responsible boolean
hiring_team.coordinators objectarray
hiring_team.coordinators.id number
hiring_team.coordinators.first_name string
hiring_team.coordinators.last_name string
hiring_team.coordinators.name string
hiring_team.coordinators.employee_id string
hiring_team.coordinators.responsible boolean
hiring_team.sourcers objectarray
hiring_team.sourcers.id number
hiring_team.sourcers.first_name string
hiring_team.sourcers.last_name string
hiring_team.sourcers.name string
hiring_team.sourcers.employee_id string
openings objectarray
openings.id number
openings.opening_id string
openings.status string
openings.opened_at string
openings.closed_at string
openings.application_id number
openings.close_reason object
openings.close_reason.id number
openings.close_reason.name string
Offers (v3) — List offers

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
version number
application_id number
job_id number
candidate_id number
opening object
opening.id number
opening.opening_id string
opening.status string
opening.opened_at string
opening.closed_at string
opening.application_id string
opening.close_reason string
created_at string
updated_at string
sent_at string
resolved_at string
starts_at string
status string
custom_fields object
keyed_custom_fields object
Offices (v3) — List offices

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
location object
location.name string
primary_contact_user_id number
parent_id number
parent_office_external_id string
child_ids array
child_office_external_ids array
external_id string
Openings (v3) — List openings

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
opening_id string
status string
opened_at string
closed_at string
application_id string
close_reason string
custom_fields object
keyed_custom_fields object
Prospect pools (v3) — List prospect pools

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
active boolean
prospect_stages objectarray
prospect_stages.id number
prospect_stages.name string
Rejection reasons (v3) — List rejection reasons

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
type object
type.id number
type.name string
Scorecards (v3) — List scorecards

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
updated_at string
created_at string
interview string
interview_step object
interview_step.id number
interview_step.name string
candidate_id number
application_id number
interviewed_at string
submitted_by object
submitted_by.id number
submitted_by.first_name string
submitted_by.last_name string
submitted_by.name string
submitted_by.employee_id string
interviewer object
interviewer.id number
interviewer.first_name string
interviewer.last_name string
interviewer.name string
interviewer.employee_id string
submitted_at string
overall_recommendation string
attributes objectarray
attributes.name string
attributes.type string
attributes.note string
attributes.rating string
ratings object
ratings.definitely_not array
ratings.no array
ratings.mixed array
ratings.yes array
ratings.strong_yes array
questions objectarray
questions.id string
questions.question string
questions.answer string
Sources (v3) — List sources

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
type object
type.id number
type.name string
User job permissions (v3) — List user job permissions

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
job_id number
user_role_id number
User roles (v3) — List user roles

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
type string
name string
Users (v3) — List users

Delta configuration: use it to request incremental data.

Setting Value
Delta filter updated_at = {{{lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss.SSS[Z]

Response schema:

Field Type
id number (Primary key)
name string
first_name string
last_name string
primary_email_address string
updated_at string
created_at string
disabled boolean
site_admin boolean
emails array
employee_id string
linked_candidate_ids array
offices objectarray
offices.id number
offices.name string
offices.location object
offices.location.name string
offices.primary_contact_user_id number
offices.parent_id number
offices.parent_office_external_id string
offices.child_ids array
offices.child_office_external_ids array
offices.external_id string
departments objectarray
departments.id number
departments.name string
departments.parent_id number
departments.parent_department_external_id string
departments.child_ids array
departments.child_department_external_ids array
departments.external_id string