Jump to Content
Home
Guides
API Reference
Guides
API Reference
v1.5.0
Home
Guides
API Reference
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.5.0
Guides
API Reference
Get Tags
Search
JUMP TO
Applicant Tracking API
INTRODUCTION
USERS OVERVIEW
Account Options
Create Account Option
post
Get Account Option
get
Update Account Option
put
Delete Account Option
delete
Create Account Option File
post
Get Account Option Files
get
Custom Workflows
Get Actions
get
Create Action
post
Get Actions
get
Get Action
get
Get Custom Workflows
get
Create Custom Workflow
post
Get Custom Workflow
get
Update Custom Workflow
put
Delete Custom Workflow
delete
Get Triggers
get
Create Trigger
post
Get Trigger
get
Update Trigger
put
Delete Trigger
delete
Get Action Types
get
Get Event Types
get
Application Files
Get Files
get
Get Files
get
Create File
post
Get File
get
Update File
patch
Delete File
delete
Get Restricted Files
get
Get Restricted Files
get
Create Restricted File
post
Get Restricted File
get
Update Restricted File
patch
Delete Restricted File
delete
Applicant Confirmation Templates
Get Templates
get
Applications
Get Secure Data
get
Update Secure Data
patch
Get Settings
get
Update Settings
patch
Get Applications
get
Create Application
post
Get Application
get
Update Application
put
Update Application
patch
Delete Application
delete
Get Resume
get
Get Signed Documents
get
Get Signed Documents
get
Get Signed Document
get
Integrations
Get Assessment Provider Subscriptions
get
Get Assessment Provider Subscriptions
get
Get Assessment Provider Subscriptions
get
Get Excluded Integration Keys
get
Get Products
get
Get Subscriptions
get
Create Subscription
post
Get Subscriptions
get
Create Subscription
post
Get Subscriptions
get
Create Subscription
post
Update Subscription
put
Delete Subscription
delete
Get Integration Partners
get
Authentication Tokens
Get Authentication Tokens
get
Create Authentication Token
post
Get Authentication Tokens
get
Create Authentication Token
post
Get Authentication Token
get
Update Authentication Token
put
Delete Authentication Token
delete
Applicant Statuses
Get Available Applicant Statuses
get
Update Available Applicant Statuses
put
Get Available Applicant Statuses
get
Update Available Applicant Statuses
put
Background Checks
Get Settings
get
Update Settings
patch
Get Settings
get
Get Settings
get
Update Settings
patch
Get Settings
get
Update Settings
patch
Create Background Check
post
Companies
Get Companies
get
Create Company
post
Get Companies
get
Get Company
get
Update Company
put
Delete Company
delete
Get Settings
get
Update Settings
patch
Get Settings
get
Update Settings
patch
JOBS OVERVIEW
Custom Fields
Get Schema Definition
get
Update Schema Definition
put
Update Schema Definition
patch
Get Schema Definition
get
Update Schema Definition
put
Update Schema Definition
patch
Get Schema Definition
get
Update Schema Definition
put
Update Schema Definition
patch
Get Schema Definition
get
Update Schema Definition
put
Update Schema Definition
patch
Get Custom Fields
get
Get Custom Fields
get
Get Custom Field
get
Payment Methods
Update Default Payment Method
put
Update Default Payment Method
put
Update Default Payment Method
put
Get Payment Methods
get
Create Payment Method
post
Get Payment Methods
get
Create Payment Method
post
Get Payment Method
get
Update Payment Method
put
Delete Payment Method
delete
EEOC
Create EEOC Data
post
Get EEOC Data
get
Assessments
Get Eligible Assessments
get
Get Eligible Assessments
get
Get Assessments
get
Create Assessment
post
Get Assessment
get
Delete Assessment
delete
Everify Requests
Get Everify Requests
get
Get Everify Requests
get
Get Everify Request
get
Extensions
Create Extension
post
Update Extension
put
Get Extension
get
Delete Extension
delete
Form Builder
Get Form
get
Get Questions
get
Get Question
get
Create Response
post
I-9 Forms
Get I-9 Forms
get
Get I-9 Forms
get
Create I-9 Form
post
Get I-9 Form
get
Delete I-9 Form
delete
Get Secure Data
get
Job Boards
Get Indeed Forbidden Terms
get
Get Available Job Boards
get
Get Job Board
get
Get Job Board Ads
get
Get Job Board Ads
get
Get Job Board Ad
get
Get Orders
get
Get Orders
get
Get Orders
get
Get Orders
get
Get Order
get
Get Packages
get
Get Packages
get
Get Package
get
Get Products
get
Get Products
get
Get Products
get
Get Products
get
Get Product
get
Get Specialties
get
Interviews
Create Pending Interview
post
Get Pending Interviews
get
Create Scheduled Interview
post
Get Scheduled Interviews
get
Create Interview Template
post
Get Interview Templates
get
Get Pending Interviews
get
Get Scheduled Interviews
get
Get Interview Templates
get
Delete Interview
delete
InterviewTemplates
Get InterviewTemplates
get
Get InterviewTemplate
get
Update InterviewTemplate
put
Delete InterviewTemplate
delete
Job Description Templates
Get Templates
get
Create Template
post
Get Template
get
Update Template
put
Delete Template
delete
Jobs
Create Job Poster
post
Create Job Poster
post
Create Job Poster
post
Create Job Poster
post
Get Jobs
get
Create Job
post
Get Jobs
get
Get Jobs
get
Create Job
post
Get Jobs
get
Create Job
post
Get Job
get
Update Job
put
Update Job
patch
Delete Job
delete
Get Active Visible Jobs
get
Get Active Visible Jobs
get
Get Active Jobs
get
Get Active Jobs
get
Get Archived Jobs
get
Get Archived Jobs
get
Get Hidden Jobs
get
Get Hidden Jobs
get
Get Visible Jobs
get
Get Visible Jobs
get
Scorecards
Get Job Scorecard Titles
get
Update Job Scorecard Titles
put
Get Reviews
get
Create Review
post
Get Review
get
Update Review
put
Delete Review
delete
Get Account Scorecard Titles
get
Update Account Scorecard Titles
put
Get Account Scorecard Titles
get
Update Account Scorecard Titles
put
Locations
Get Locations
get
Create Location
post
Get Locations
get
Create Location
post
Get Location
get
Update Location
put
Deletes a location, along with its jobs, apps, and any other location resources.
delete
Messages
Get Messages
get
Create Message
post
Get Message
get
Notes
Get Notes
get
Get Notes
get
Create Note
post
Get Notes
get
Get Note
get
Delete Note
delete
Offer Letters
Get Offer Letters
get
Reviews
Get Reviews
get
Get Reviews
get
Create a review.
post
Get Reviews
get
Get Review
get
Update Review
put
Delete Review
delete
Sites
Get Sites
get
Create Site
post
Get Sites
get
Get Sites
get
Create Site
post
Get Site
get
Update Site
patch
Update Site
put
Delete Site
delete
Tags
Get Tags
get
Get Tags
get
Get Tags
get
Get Tags
get
Users
Get Roles
get
Get Roles
get
Get Roles
get
Get Users
get
Create User
post
Get Users
get
Get Users
get
Create User
post
Get User
get
Update User
put
Delete User
delete
Webhooks
Create Webhook
post
Get Webhooks
get
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
Workflow Settings
Get Settings
get
Update Settings
patch
Private Label API
Custom Workflows
Get Actions
get
Create Action
post
Get Custom Workflows
get
Create Custom Workflow
post
Get Triggers
get
Create Trigger
post
Application Files
Get Files
get
Get Restricted Files
get
Applicant Confirmation Templates
Get Templates
get
Applications
Get Settings
get
Update Settings
patch
Get Applications
get
Create Application
post
Billing
Get Charges
get
Get Payments
get
Get Plans
get
Job Description Templates
Get Templates
get
Create Template
post
Workflow Settings
Get Settings
get
Update Settings
patch
Integration Partner API
/partners/applications
Returns a paginated list of applications. Optional "page" and "per_page" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.
get
Create a new application.
post
/partners/companies/{company_id}/applications
Returns a paginated list of applications. Optional "page" and "per_page" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.
get
Create a new application.
post
/partners/applications/{id}
Get a single application.
get
Update an application.
put
/partners/companies/{company_id}/applications/{id}
Get a single application.
get
Update an application.
put
/partners/applications/{application_id}/files
Lists all files on an application.
get
Allows you to create a new file for an applicant.
post
/partners/companies/{company_id}/applications/{application_id}/files
Lists all files on an application.
get
Allows you to create a new file for an applicant.
post
/partners/applications/{application_id}/files/{id}
View an existing file.
get
/partners/companies/{company_id}/applications/{application_id}/files/{id}
View an existing file.
get
/api/v1/partners/companies/{company_id}/available_products
Get the available products of a company.
get
Update the available products of a company.
put
/partners/companies
Lists all companies current subscribed.
get
/partners/companies/{id}
View a subscribing company.
get
/partners/jobs
Returns a paginated list of jobs of a subscribed company. Optional "page" and "per_page" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.
get
/partners/companies/{company_id}/jobs
Returns a paginated list of jobs of a subscribed company. Optional "page" and "per_page" parameters may be passed. If parameters are not present, the 1st page of up to 1000 results will be returned by default.
get
/partners/jobs/{id}
Gets a single job.
get
/partners/companies/{company_id}/jobs/{id}
Gets a single job.
get
/partners/jobs/feed
Returns a paginated list of jobs
get
/partners/applications/{application_id}/assessments
Lists all assessments on an application.
get
/partners/companies/{company_id}/applications/{application_id}/assessments
Lists all assessments on an application.
get
/partners/assessments/{id}
Get a single partner assessment.
get
Update a partner assessment.
put
/partners/applications/{application_id}/assessments/{id}
Get a single partner assessment.
get
Update a partner assessment.
put
/partners/companies/{company_id}/applications/{application_id}/assessments/{id}
Get a single partner assessment.
get
Update a partner assessment.
put
/partners/jobs/{job_id}/questions
Lists all questions for a job.
get
/partners/companies/{company_id}/jobs/{job_id}/questions
Lists all questions for a job.
get
/partners/applications/{application_id}/questions/{question_id}/question_responses
Allows you to create a response for an existing assessment question
post
/partners/applications/{application_id}/restricted_files
Allows you to create a new restricted file for an applicant.
post
/partners/webhooks
Allows you to register a new webhook.
post
Lists all webhooks on an extension.
get
/partners/webhooks/{id}
View an existing webhook.
get
Update a webhook's details.
put
Delete an existing webhook.
delete
Powered by
Get Tags
get
https://api.applicant-tracking.com/api/v1/applications/tags
Lists all tags.
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!