Jump to Content

Home Guides API Reference

Guides API Reference

v1.5.0

Home Guides API Reference Log In

API Reference

v1.5.0Guides API Reference

All

Pages

Start typing to search…

Applicant Tracking API

Private Label API

Custom Workflows
Application Files
- Get Filesget
- Get Restricted Filesget
Applicant Confirmation Templates
- Get Templatesget
Applications
Billing
Job Description Templates
- Get Templatesget
- Create Templatepost
Workflow Settings
- Get Settingsget
- Update Settingspatch

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 jobsget
/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 questionpost
/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}

Powered by

Get Settings

get https://api.applicant-tracking.com/api/v1/background_checks/settings

Lists all background check settings.

Language

Click Try It! to start a request and see the response here!