Jump to Content

API Reference

v3API Reference

All

Pages

Start typing to search…

Overview

Welcome
Authorization
Rate Limiting
Changelog
Webhooks

Object Models

Assessment
Background Check
Candidate
Candidate Questionnaire
Company
Interview Guide
Pipeline
Position
Questionnaire
Scorecard
Task
Template
User
Position Custom Field
Candidate Custom Field

Authorization Endpoints

/signinpost
/signoutget

User Endpoints

/userget
/user/detailsget

Company Endpoints

/company/:id/get
/company/:id/custom-attributes/candidateget
/company/:id/custom-attributes/positionget
/company/:id/pipeline/:idget
/company/:id/pipelinesget
/company/:id/questionnaire/:idget
/company/:id/questionnairesget
/company/:id/template/:idget
/company/:id/templatesget
/companiesget

Position Endpoints

./position/:idget
./position/:idput
./position/:id/stateput
./position/:id/streamget
./position/:id/teamget
./positionsget
./positionspost
./position/:id/custom-fieldsget
./position/:id/custom-fields/:idput

Candidate Endpoints

./candidate/:idget
./candidate/:idput
./candidate/:id/assessmentsget
./candidate/:id/background-checksget
./candidate/:id/conversationget
./candidate/:id/conversationpost
./candidate/:id/custom-attributeput
./candidate/:id/documentsget
./candidate/:id/documentspost
./candidate/:id/educationput
./candidate/:id/metaget
./candidate/:id/movepost
./candidate/:id/questionnaire/:idpost
./candidate/:id/questionnairesget
./candidate/:id/resumepost
./candidate/:id/resumeget
./candidate/:id/scorecardput
./candidate/:id/send-questionnairepost
./candidate/:id/stageput
./candidate/:id/streamget
./candidate/:id/streampost
./candidate/:id/work-historyput
./candidatesget
./candidatespost
./candidates/resumepost
./candidates/searchget
./candidate/:id/custom-fieldsget
./candidate/:id/custom-fields/:idput

Contact

Twitter (@Breezy_HR)
Email ([email protected])

API Settings — Test

Getting Started With Your API

Powered by

Template

{
  "_id": String,
  "name": String,
  "body": String
}