Jump to Content
Guides
API Reference
Changelog
API Reference
Guides
API Reference
Changelog
Overview
Search
All
Pages
Start typing to search…
JUMP TO
Apply API
Overview
Application API
Create a New Candidate Application
post
Get application configuration for posting
get
Get candidate status
get
Approvals API
Overview
approvals
Get approval request by id
get
Get comments for given approval request
get
Add comment to given approval request
post
Get pending approvals requests where you are an approver.
get
Create approval request
post
Approve the approval request by id
post
Reject the approval request by id
post
Apps Integrations API
Overview
partner-api
Enables integration
post
Assessment Partner Application
Overview
integration
Shows consent form on partner side
get
Removes integration on partner side
del
packages
Retrieves a list of packages
get
Retrieves a package by id
get
orders
Orders assessment package for candidate
post
Orders inline assessment package for candidate
post
token
Exchange credentials for an access token
post
Assessment Partner API
Overview
configuration
get partner configuration
get
saves configuration for partner
put
integration
enable the company integration
post
result
updates package result
patch
add attachment to order
post
Assessments API
Overview
assessment orders
Retrieves all assessment orders for specified application
get
Audit API
Overview
audit
List audit events
get
Candidates API
Overview
candidates
Add tags to a candidate
post
Get tags for a candidate
get
Update tags for a candidate
put
Delete tags for a candidate
del
Get Onboarding Status for a candidate
get
Set Onboarding Status for a candidate
put
Get Onboarding Status for a candidate associated with given job
get
Sets Onboarding Status for a candidate associated with given job
put
Search candidates
get
Create a new candidate and assign to a Talent Pool
post
Parse a resume, create a candidate and assign to a Talent Pool.
post
Request consent from multiple candidates
post
Status of candidate consent
get
Candidate consent decisions
get
Get details of a candidate
get
Delete Candidate
del
Update candidate personal information
patch
Get list candidate's attachments.
get
Attach files to a candidate.
post
Get a candidate's attachment.
get
Get list of candidate's attachments in context of given job.
get
Attach file to candidate in context of given job.
post
Get candidate's attachment.
get
Delete attachment.
del
Update a candidate's status
put
Update a candidate's status on primary assignment
put
Get candidate's status history
get
Get candidate's status history for a candidate's job
get
Update a candidate's source
put
Get candidate property values for a candidate
get
Get candidate property values for a candidate's job
get
Add/update candidate properties values
put
Add/update candidate property value
put
Add/update candidate property value
put
Get candidate screening answers for a candidate's job
get
Create a new candidate and assign to a job
post
Parse a resume, create a candidate and assign to a job.
post
Get details of a candidate's application to a job
get
Delete candidate's application to a job
del
Candidate status Public API
candidate-status
Get candidate status
get
Overview
Configuration API
configuration
Create access group
post
List access groups
get
Get access group
get
Update access group
put
Delete access group
del
Get company information
get
Get a list of available job properties
get
Create a job property
post
Get job property by id
get
Update a job property
patch
Add a job property's translations
patch
Get available job property values
get
Create a job property value
post
Archive a job property value
del
Unarchive a job property value
put
Update a job property value
patch
Add a job property value's translations
patch
Archive a job property value
put
Unarchive a job property value
del
Activate a job property
put
Deactivate a job property
del
Get job property's dependents
get
Create job property dependents
post
Remove job property's dependent
del
Get dependent job property's values
get
Get job property's dependent values
get
Add job property's dependent value
post
Remove job property's dependent values relationship
del
Creates department
post
Get departments
get
Get department
get
Get list of hiring process
get
Get hiring process
get
Get a list of available offer properties
get
Get a list of available candidate properties
get
Get candidate property by id
get
Get Candidate Property values
get
Create candidate property value
post
Get Candidate Property value by id
get
Update candidate property value label
put
Remove candidate property value
del
List candidate source types with subtypes
get
List candidate sources
get
Get a candidate source
get
Get a candidate source by identifier.
get
Get rejection reasons
get
Get withdrawal reasons
get
List career sites configurations
get
Get details of career site configuration
get
Overview
predefined-locations
Get list of predefined locations
get
Create predefined location
post
Remove multiple predefined locations
del
Get predefined location by id
get
Update predefined location
put
Remove predefined location
del
Event management API
Overview
events
Get event's details
get
Update event
put
Delete event
del
Add interviewers to event's session
put
Remove interviewers from event's session
del
Move applicants from session to session
put
Add applicants from event pool to session
post
Get job's events
get
Create event
post
Get all applicants (both event-applicants-pool and session-applicants) for specified event
get
Add applicants to event pool
post
Get event's session details
get
Delete event's session
del
Get event's applicants
get
Get candidate events
get
Get application events
get
Feed
Overview
feed
Get posting by id
get
Update posting information
put
Get a list of postings
get
Interviews
Overview
interview types
Retrieves interview types
get
Adds interview types to already existing ones
patch
Removes interview type with given name
del
interviews
Retrieves a list of interviews
get
Creates an interview
post
Retrieves an interview
get
Modifies an interview
patch
Deletes an interview
del
statuses
Changes a candidate's status.
put
Changes a interviewer's status in given timeslot
put
Changes a candidate's status in given timeslot
put
timeslots
Creates a timeslot
post
Retrieves a timeslot
get
Modifies a timeslot
patch
Deletes a timeslot
del
Changes no-show value in a timeslot
patch
Job Applications API
Overview
job-applications
Get a job application
get
Delete a job application
del
Interview Templates API
Overview
interview-templates
Get managed hiring process steps for the job.
get
Get interview template by id.
get
Update managed steps for the job.
put
Update interview template.
put
Get interview template by id.
get
Removes interview template.
del
Update interview template by id.
put
Remove interview template by id.
del
Update job interview template.
put
Update interviewers selection for job interview template.
patch
Search for all interview templates.
get
Create interview template.
post
Find interview templates for the job
get
Find interview templates for job application id.
get
Get interview templates for the current company.
get
Create a interview template.
post
job-level-interview-templates
Update job level interview template.
put
Patches job level interview template's interviewers pool.
patch
Finds job level interview templates for job id, hiring step and hiring stage.
get
Save / replace job level interview templates for job id, hiring step and hiring stage.
put
Finds job level interview templates by job application IDs
post
Finds job level interview templates for a job
get
Finds job level interview templates by job application id
get
schedule-preferences
Find schedule preferences
get
Jobs API
Overview
jobs
Positions for a job
get
Create a new position for a job
post
Get a single position
get
Update position
put
Delete position
del
Find and list job ads for a given job
get
Create a new job ad
post
Get a job ad
get
Update a job ad
put
Publishes a job ad
post
List publications for a job ad
get
Unpublish a job ad
del
Publishes a default job ad
post
Unpublishes a job from all sources
del
Find and list publications for a job
get
Get hiring team of a job with a given id.
get
Add hiring team member of a job with a given id.
post
Removes hiring team member of a job with a given id.
del
Get note of a job.
get
Update note of a job.
put
Update job headcount.
patch
Search jobs
get
Create a new job
post
Get content of a job with a given id.
get
Update a job
patch
Updates job
put
Updates job status
put
Job status history
get
Get latest approval request for given job
get
Messages API
Overview
messages
Shares new messages on Hireloop with Users, Hiring Teams or Everyone and sends emails.
post
Delete a message
del
Fetch messages
get
Message templates API
Overview
message-templates
Get a message template by id.
get
Update Message Template
put
Remove a message template by id.
del
Get Message Templates
get
Create Message Template
post
Offers API - version 1
Overview
offers
Get candidate's offers
get
Get candidate's offer
get
Get latest approval request for candidate's offer
get
Search offers
get
Get a list of documents related to sent offer.
get
Get a given document in a given sent offer
get
partners-public-api (deprecated)
Overview
configs
Fetch list of vendor configs
get
Add new config
post
Get config for vendor
get
Update config
post
offers
Search offers by criteria
get
Posting API - version 1
Overview
postings
Lists active postings published by given company
get
Get posting by posting id or uuid for given company
get
List departments for given company
get
Reviews
Overview
reviews
Retrieves all reviews for specified candidate and job
get
Creates a review
post
Retrieves a review
get
Updates a review
patch
Deletes a review
del
scorecards
Retrieves all criteria for specified job
get
Reporting API
Overview
files
Get report file
get
Download report file
get
reports
Get report files
get
Generate ad-hoc report
post
Get reports
get
Get report
get
Get most recent report file
get
Download most recent report file
get
Self Scheduling API
self-schedules
Returns self-scheduled interview
get
Update a self schedule interview
put
Create a self schedule interview
post
Creates automated self schedule.
post
Requests invite update for automated self-schedule
post
Requests self reschedule for candidate for automated self-schedule.
post
Search for a self-scheduling instances
get
Gets self schedule by id
get
Cancels self schedule
del
Retrieve application-related details for a self-scheduling instance
get
Get self-schedule slots for application
get
SmartOnboard
Overview
new-hires
Returns details for a single New Hire
get
onboarding-processes
Returns details of a single Onboarding Process
get
assignments
Returns Assignments associated with a single Onboarding Process
get
Returns specific Assignment associated with a single Onboarding Process
get
assignments-submissions
Returns answers submitted for a single Web Form Assignment
get
Returns metadata for the fields that belong to a single Web Form Assignment
get
Returns answers submitted for a single Fillable PDF Form Assignment
get
Returns list of Attachments submitted for a single Activity Assignment
get
Returns single Attachment for specific Activity Assignment
get
Users API
Overview
users
List users of your company
get
Create a new user.
post
Get details of my user
get
Get details of a user with given id
get
Update a user
patch
Send a password reset email to a user
post
Send an activation email to a user
post
Activate a user
put
Deactivate a user
del
Update user avatar
put
List system roles
get
List access groups configured in your company
get
Remove user from access group
del
Assign users to access group
post
Url shortener API
shortener
Shorten URL
post
Users API (Deprecated)
Overview
users
List users of your company
get
Create a new user
post
Get details of my user
get
Get details of a user with given id
get
Deactivate a user
del
Update a user
patch
Send an activation email to a user
post
Activate a user
put
Deactivate a user
del
Update user avatar
put
Webhooks
Overview
subscriptions
Subscribe to a webhook.
post
Retrieve webhook subscriptions.
get
Retrieve single webhook subscription.
get
Delete webhook subscription.
del
Activate webhook subscription.
put
Generate a secret key for a webhook subscription.
post
Retrieve subscription secret key
get
Retrieve callback request details starting from the newest.
get
Overview
OpenAPI Specification
