Introduction

 

The Recruiterbox API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. JSON is returned by all API responses, including errors.

If you need a version that supports cross-origin resource sharing (CORS), allowing you to interact securely with our API from a client-side web application, use this version of our API. This API is to access publicly available data from Recruiterbox. Using these APIs, developers can enhance or customize the way their data is rendered. These do not require any authentication as these are publicly available data.

If you are looking for the older version of our Backend APIs it can be found here. We recommend you use this newer version of our API

Authentication

 

Overview

Accessing the Recruiterbox API

To invoke the Recruiterbox API, you need to generate an API key. Refer to the section Generating an API Key for more details.

Making requests

Requests are authenticated using HTTP Basic Auth. Provide your API key as the basic auth username. You do not need to provide a password.

Example request using your API key.

curl -u {api_key}: https://api.recruiterbox.com/v2/openings -H "Content-Type: application/json"

Generating an API Key

 

Steps to generate an API key

To generate an API key, go to the Settings section within the Recruiterbox app and click "API Key".

Settings

Settings

API Key

API Key

Click Generate

Click Generate

Copy this key to embed in your requests.

Copy this key to embed in your requests.

Pagination

 

REST framework includes support for customizable pagination styles. This allows you to modify how large result sets are split into individual pages of data.

The Recruiterbox API provides a wealth of information for developers to consume. Most of the time, you might even find that you're asking for too much information, and in order to keep our servers happy, the API will automatically paginate the requested items.

All requests that return multiple items will be paginated to 20 items by default. This can be changed by specifying a limit parameter. To specify which page, use the offset parameter.

Example scenario:

If you have a total of 40 records and they are paginated with a page size of 10 (i.e. limit=10). The first page will be offset=0 by default. You will need to make subsequent requests by incrementing the offset by 10 each time.

Paginating a list of candidates by fetching 20 items per page

Paginating a list of candidates by fetching 20 items per page

Openings

 

The openings API allows you to get or list the openings for a client.

Opening Object

 

Opening Object Schema

The Opening object contains the details of an opening.

Field
Field Type
Description

id

Integer

Unique identifier for this opening object.

title

String

Name of the opening. E.g. "Software Engineer" or "Project Manager"

description

String

A more detailed description about the opening.

team

String

The name of the team within the organization who is hiring for this opening.

E.g. "Sales and Marketing" or "Engineering".

position_type

String

An enumeration that can have any of the values contract, full_time, part_time

is_remote_allowed

Boolean

Whether the position allows working remotely.

location.city

String

City of the opening location

location.state

String

State of the opening location

location.zipcode

String

ZipCode of the opening location

location.country

String

Country of the opening location

is_private

Boolean

Whether this opening is published on the job site

hosted_url

String

Recruiterbox allows you to create a branded careers site for your organization. This field gives you the URL of the Opening within the careers site.

is_private

Boolean

Indicates whether this opening is marked as a private opening.

For more details refer to [this Recruiterbox features page on Private openings

application_email

String

Recruiterbox allows you to add candidates to an opening by sending the candidate resumes to an email address.

is_archived

Boolean

Recruiterbox allows you to archive an opening, once you are done hiring for it. This field indicates whether the field is archived.

created_on

Datetime

Timestamp of when the opening details were created

modified_on

Datetime

Timestamp of when the opening details were last modified.

stages

Array

List of stages configured in the Hiring Workflow for a particular opening. E.g. Screening, Telephone Interview, Make Offer etc.

application_form_fields

Array

List of configured questions that an applicant will have to answer while applying via the Recruiterbox-hosted careers page. (link to which is available in the hosted_url field)

Example Opening Object

List all Openings

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/openings
curl -u {api_key}: https://api.recruiterbox.com/v2/openings -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Optional Query String Parameters

Parameter
Description

offset

Starting position from which to fetch objects

limit

A limit on the number of objects returned

{
  "objects": [
    {
			"id": 136691,
      "title": "UX Desginer",      
      "description": "Hiring a UX Designer for our Front End Team",
      "position_type": "full_time",
      "is_remote_allowed": false,
      "is_archived": false,
      "is_private": false,
      "location": {
        "city": "Bangalore",
        "state": "Karnataka",
        "zipcode": "560078",
        "country": "India"
      },
      "team": "Front-end Team",
			"created_date": 1472804002,
      "modified_date": 1472804018,
      "application_email": "recruiterbox-dmcc0616@applications.recruiterbox.com",
      "hosted_url": "https://recruiterbox.recruiterbox.com/jobs/d933h5yh",
      "stages": [
        {"id": 72804, "name": "Screening"},
        {"id": 72805, "name": "Telephone Interview"},
				{"id": 72806, "name": "Face to face Interview"},
				{"id": 72807, "name": "Make Offer"},
      ],
      "application_form_fields": [
        {"display_name": "Experience Level"},
        {"name": "experience_level"},
        {"type": "select_one"}, // Other supported types: "small_text", "large_text", "select_multiple", "url", "email", "number", "date", "file"
        {"position": 1},
        {"choices": ["0 - 2 Years", "2 - 5 Years", ""]},
        {"is_required": true},
        {"is_disabled": false}
      ]
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Read an Opening

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/openings/opening_id
curl -u {api_key}: https://api.recruiterbox.com/v2/openings/:opening_id -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Path Params

opening_id
int32
required

Unique identifier of the opening being read.

 

Sample Output

{
			"id": 136691,
      "title": "UX Desginer",      
      "description": "Hiring a UX Designer for our Front End Team",
      "position_type": "full_time",
      "is_remote_allowed": false,
      "is_archived": false,
      "is_private": false,
      "location": {
        "city": "Bangalore",
        "state": "Karnataka",
        "zipcode": "560078",
        "country": "India"
      },
      "team": "Front-end Team",
			"created_date": 1472804002,
      "modified_date": 1472804018,
      "application_email": "recruiterbox-dmcc0616@applications.recruiterbox.com",
      "hosted_url": "https://recruiterbox.recruiterbox.com/jobs/d933h5yh",
      "stages": [
        {"id": 72804, "name": "Screening"},
        {"id": 72805, "name": "Telephone Interview"},
				{"id": 72806, "name": "Face to face Interview"},
				{"id": 72807, "name": "Make Offer"},
      ],
      "application_form_fields": [
        {"display_name": "Experience Level"},
        {"name": "experience_level"},
        {"type": "select_one"}, // Other supported types: "small_text", "large_text", "select_multiple", "url", "email", "number", "date", "file"
        {"position": 1},
        {"choices": ["0 - 2 Years", "2 - 5 Years", ""]},
        {"is_required": true},
        {"is_disabled": false}
      ]
    }

Create an Opening

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.recruiterbox.com/v2/openings
curl --request POST \
  --url https://api.recruiterbox.com/v2/openings
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.recruiterbox.com/v2/openings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.recruiterbox.com/v2/openings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.recruiterbox.com/v2/openings");

xhr.send(data);
import requests

url = "https://api.recruiterbox.com/v2/openings"

response = requests.request("POST", url)

print(response.text)
A binary file was returned
Try the API to see results

Body Params

title
string
required

Name of the opening. E.g. "Software Engineer" or "Project Manager"

description
string

A more detailed description about the opening

team
string

The name of the team within the organization who is hiring for this opening

position_type
string

An enumeration that can have any of the values contract, full_time, part_time

is_allowed_remote
boolean

Whether the position allows working remotely

location
object
 
location.city
string
location.state
string
location.zipcode
string
location.country
string
is_private
boolean

Whether this opening is published on the job site

hosted_url
string

Recruiterbox allows you to create a branded careers site for your organization. This field gives you the URL of the Opening within the careers site

application_email
string

Recruiterbox allows you to add candidates to an opening by sending the candidate resumes to an email address

is_archived
boolean

Recruiterbox allows you to archive an opening, once you are done hiring for it. This field indicates whether the opening is archived.

 
curl -u c2b5c06b22e848b381ccdf3dfaa337fe: https://api.recruiterbox.com/v2/openings -H "Content-Type: application/json" -X POST -d '{
  "title": "Executive Assistant"
}'

Candidates

 

This is an object that represents a candidate in Recruiterbox. You can read, add and modify attributes on candidates that you have access to.

The candidate Object

 

Candidate Object Schema

The candidate object contains the metadata about a candidate

Field
Field Type
Description

id

Integer

Unique ID of the candidate

first_name

String

First name of the candidate

last_name

String

Last name of the candidate

email

String

Email ID of the candidate

phone

String

Phone number of the candidate

description

String

A brief description about the candidate.

resume.file_name

String

File name of the resume.

resume.content

String

Contents of the file in a Base64 encoded format. This field is available only for creating and editing resumes on a candidate.

resume.file_url

Url
(readonly)

A hyperlink which links to location where the resume can be downloaded.

created_date

Timestamp

(read only)

Timestamp of when the candidate was added to Recruiterbox

updated_date

Timestamp

(read only)

Timestamp of when the candidate details were last updated.

profile_data

Array of objects

In addition to the details above, Recruiterbox allows you to add custom metadata to candidates.

For example, you want to specify a candidate's github profile, or his salary expectation, then the the profile data will look like

[{ 
"name" : "github profile", 
"value": "https://github.com/johndoe" 
}]

source

String

This represents the source to which a candidate is attributed to in Recruiterbox. For example, if the candidate came from a job board called Acme Inc. then the source will be Acme Inc.

source_type

String
(read only)

Represents the source type.
In cases when a candidate is created using the api, it will be API

created_by

Object
(read only)

An object representing the user who created the candidate which is the form

{ 
  "id": 1,
  "email": "john@doe.com",
  "name": "John Doe"
}

assigned_to

Object
(read only)

An object representing the user who is assigned to the candidate

opening_id

Integer (read only)

Unique Id of the Opening to which the candidate belongs

stage_id

Integer (read only)

Unique Id of the Stage to which the candidate belongs

stage_name

String (read only)

Name of the Stage to which the candidate belongs

state

String (read only)

Describes the state in which the candidate is. Can be one of ['in_process' 'hired' 'rejected' 'declined_offer' 'onhold' 'withdrawn' 'spam' 'archived' 'onhold_prospecting' 'did_not_convert']

Example Candidate Object

{
  "updated_date": 1473159406,
  "first_name": "richard",
  "last_name": "hendricks",
  "description": "Test from API",
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks resume.txt"
  },
  "email": "rhendricks@piedpiper.com",
  "opening_id": 136691,
  "created_date": 1473159405,
  "source_id": 339,
  "external_id": 123123123,
  "id": 11200501,
    "profile_data": [
        {
          "name": "Linkedin",
          "value": "https://www.linkedin.com/us/rhendricks"
        },
        {
          "name": "Twitter",
          "value": "https://twitter.com/rhendricks"
        },

        {
          "name": "Current Location",
          "value": "Silicon Valley, California"
        },
    ],
}

List all Candidates

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/candidates
curl -u {api_key}: https://api.recruiterbox.com/v2/candidates
A binary file was returned
Try the API to see results

Query Params

offset
int32

Index at which to start fetching records

limit
int32

Number of records to fetch

opening_id
int64

Filter by opening

 

Read a Candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/candidates/candidate_id
curl -u {api_key}: https://api.recruiterbox.com/v2/candidates/:candidate_id 
A binary file was returned
{
  "id": 11200501,
  "first_name": "richard",
  "last_name": "hendricks",
  "description": "Test from API",
  "profile_data": [],
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks resume"
  },
  "email": "rhendricks@piedpiper.com",
  "created_date": 1473159405,
  "source": 'Acme Inc.',
  "updated_date": 1473159406,
  "created_by": {
    	"id": 10, 
    	"name": "John Doe", 
    	"email": "john@acme.com"
  },
  "assigned_to": {
    	"id": 11, 
    	"name": "Jane Doe", 
    	"email": "jane@acme.com"
  },
  "opening_id": 45528,
	"stage_id": 470625,
  "stage_name": "Screening",
  "state": "in_process"
}

Path Params

candidate_id
int32
required
 

Create a Candidate

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.recruiterbox.com/v2/candidates
curl -u c2b5c06b22e848b381ccdf3dfaa337fe: https://api.recruiterbox.com/v2/candidates -H "Content-Type: application/json" -X POST -d '{
  "first_name": "richard",
  "last_name": "hendricks",
  "email": "rhendricks@piedpiper.com",
  "phone": "+1-202-555-0151",
  "description": "Test from API",
  "profile_data": [{"name": "Age", "value": "26"}],
  "source": "Acme Inc.",
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks_resume.txt"
  }
}'
A binary file was returned
{
  "id": 11200501,
  "first_name": "richard",
  "last_name": "hendricks",
  "description": "Test from API",
  "profile_data": [],
  "resume": {
    "file_uri": "https://api.recruiterbox.com/api/v1/docs/SGVsbG8gbXkgbmF/get_file",
    "file_name": "hendricks resume.txt"
  },
  "email": "rhendricks@piedpiper.com",
  "source": 'Acme Inc.',
  "created_date": 1473159405,
  "updated_date": 1473159405,
  "created_by": {
    	"id": 10, 
    	"name": "John Doe", 
    	"email": "john@acme.com"
  },
  "assigned_to": {
    	"id": 11, 
    	"name": "Jane Doe", 
    	"email": "jane@acme.com"
  }
}

Body Params

first_name
string
required

First name of the candidate

last_name
string

Last name of the candidate

email
string
required

Email ID of the candidate

phone
string

Phone number of the candidate

description
string

Description of the candidate

profile_data
array of objects

Array of objects of the schema { "name" : "field name", "value": "field value" }

name
value
resume
object
 
resume.file_name
string

File name of the resume

resume.content
string

Base64 encoded file content.

source
string
required

Source of the candidate

 

Edit a Candidate

 

Basic Auth

 Authentication is required for this endpoint.
patchhttps://api.recruiterbox.com/v2/candidates/id
curl -u {api_key}: https://api.recruiterbox.com/v2/candidates -H "Content-Type: application/json" -X POST -d '{
  "first_name": "richard",
  "last_name": "hendricks",
  "email": "rhendricks@piedpiper.com",
  "phone": "+1-202-555-0151"
  "description": "Test from API",
  "profile_data": [{'name': 'Age', 'value': '26'}],
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks resume.txt"
  },
}'
A binary file was returned
{
  "id": 11200501,
  "updated_date": 1473159406,
  "first_name": "richard",
  "last_name": "hendricks",
  "description": "Test from API",
  "profile_data": [],
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks resume.txt"
  },
  "email": "rhendricks@piedpiper.com",
  "opening_id": 136691,
  "created_date": 1473159405,
  "source": 'Acme Inc.',
  "created_by": {
    	"id": 10, 
    	"name": "John Doe", 
    	"email": "john@acme.com"
  },
  "assigned_to": {
    	"id": 11, 
    	"name": "Jane Doe", 
    	"email": "jane@acme.com"
  }
}

Path Params

id
int64
required

Body Params

first_name
string

First name of the candidate

last_name
string

Last name of the candidate

email
string

Email ID of the candidate

phone
string

Phone number of the candidate

description
string

Description of the candidate

profile_data
array of objects

Array of objects of the schema { "name" : "field name", "value": "field value" }

name
value
resume
object
 
resume.file_name
string

File name of the resume

resume.content
string

Base64 encoded file content.

source
string

Source of the candidate

 

Delete a Candidate

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.recruiterbox.com/v2/candidates/candidate_id
curl -u {api_key}: https://api.recruiterbox.com/v2/candidates/:candidate_id 
A binary file was returned
{
  "id": 11200501,
  "first_name": "richard",
  "last_name": "hendricks",
  "description": "Test from API",
  "profile_data": [],
  "resume": {
    "content": "SGVsbG8gbXkgbmFtZSBpcyBhc2h3aW4uIGdpdmUgbWUgYSBqb2Iu",
    "file_name": "hendricks resume"
  },
  "email": "rhendricks@piedpiper.com",
  "opening_id": 136691,
  "created_date": 1473159405,
  "source": 'Acme Inc.',
  "external_id": 123123123,
  "updated_date": 1473159406,
  "created_by": {
    	"id": 10, 
    	"name": "John Doe", 
    	"email": "john@acme.com"
  },
  "assigned_to": {
    	"id": 11, 
    	"name": "Jane Doe", 
    	"email": "jane@acme.com"
  }
}

Path Params

candidate_id
int32
required
 

Candidate Messages

 

Candidate Message Schema

Field
Field Type
Description

id

Integer

Unique ID of the conversation thread

recipients

Array

Array of objects containing name and email of all participants in a conversation
[{name: "", email: ""}...]

messages

Array

Contains all messages in a conversations

candidate

Object

Info about the candidate. For now, contains unique ID.

is_private

Boolean

Specifies whether this conversation was marked as private.

Schema for individual messages in a conversation (Candidate Message)

Field
Field Type
Description

sender

Object

Provides name and email of sender in the format {name:"", email: ""}

subject

String

Subject of message

body

String

Content of message

date

DateTime

Timestamp when message was sent

attachments

Array

Array of objects of the format {file_name: "", url: ""}

List all Messages

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/candidate_messages
curl -u {api_key}: https://api.recruiterbox.com/v2/candidate_messages -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Optional Query String Parameters

Parameter
Description

offset

Starting position from which to fetch objects

limit

A limit on the number of objects returned

Filter by Candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/candidate_messages
curl -u {api_key}: https://api.recruiterbox.com/v2/candidate_messages?candidate_id=0 -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

candidate_id
int32

Candidate for which to get messages

 

Read a Candidate Message

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/candidate_messages/id
curl -u {api_key}: https://api.recruiterbox.com/v2/candidate_messages/id
A binary file was returned
Try the API to see results

Path Params

id
int32
required
 

Internal Notes

 

Fetch internal notes around candidates. i.e. Conversation between users on a candidate profile. This is different from candidate messages, where the candidate is also involved in the conversation.

Internal Notes Schema

Field
Field Type
Description

id

Integer

Unique ID of the conversation thread

recipients

Array

Array of objects containing name and email of all participants in a conversation
[{name: "", email: ""}...]

messages

Array

Contains all messages in a conversations

candidate

Object

Info about the candidate. For now, contains unique ID.

is_private

Boolean

Specifies whether this conversation was marked as private.

Schema for individual messages in a conversation

Field
Field Type
Description

sender

Object

Provides name and email of sender in the format {name:"", email: ""}

subject

String

Subject of message

body

String

Content of message

date

DateTime

Timestamp when message was sent

attachments

Array

Array of objects of the format {file_name: "", url: ""}

List all Internal Notes

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/internal_notes
curl -u {api_key}: https://api.recruiterbox.com/v2/internal_notes -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Optional Query String Parameters

Parameter
Description

offset

Starting position from which to fetch objects

limit

A limit on the number of objects returned

{
  "objects": [
    {
      "is_private": false,
      "date": null,
      "messages": [
        {
          "body": "Something",
        	"date": 1484285543,
        	"id": "4",
        	"sender": {
            "name": "User 4",
      			"email": "user4@xyz.com"
          }
        }
      ],
      "id": 15,
  		"candidate": {
        "id": 2
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Read an Internal note

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/internal_notes/id
curl -u {api_key}: https://api.recruiterbox.com/v2/internal_notes/id 
A binary file was returned
{
"is_private": false,
"messages": [
	{
		"body": "New note ",
		"date": 1484892079,
		"id": 3,
		"sender": {
				"name": "User 0",
				"email": "demoaccount@recruiterbox.com"
		},
		"attachments": [
			{
				"url":"link/to/attachment",
 				"file_name": "cloudy_sun.jpg"
			}
		]
	}
],
"recipients": [
	{
		"name": "User 0",
		"email": "demoaccount@recruiterbox.com"
	}
],
"candidate": {
		"id": 19
},
	"id": 3
}
}

Path Params

id
int32
required
 

Filter by Candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/internal_notes
curl -u {api_key}: https://api.recruiterbox.com/v2/internal_notes?candidate_id=0 -H "Content-Type: application/json"
A binary file was returned
{
"is_private": false,
"messages": [
	{
		"body": "New note ",
		"date": 1484892079,
		"id": 3,
		"sender": {
				"name": "User 0",
				"email": "demoaccount@recruiterbox.com"
		},
		"attachments": [
			{
				"url":"link/to/attachment",
 				"file_name": "cloudy_sun.jpg"
			}
		]
	}
],
"recipients": [
	{
		"name": "User 0",
		"email": "demoaccount@recruiterbox.com"
	}
],
"candidate": {
		"id": 19
},
	"id": 3
}
}

Query Params

candidate_id
int32

Filter message by candidate

 

Interviews

 

Fetch all interviews and related details

Field
Type
Description

id

Integer

Unique ID for this record

title

String

Title for the interview E.g. Phone Interview with Noemi McGrath

description

String

Some description for the interviewer(s)

time

Timestamp

Date and Time of interview

duration

Integer

Duration of interview in minutes

location

String

Place of interview E.g. 3rd Floor Cafeteria

type

Object

Some metadata containing interview information E.g.
{name: "Phone", metadata: {phone_number: "+1-39834 343"}

candidate

Object

Details of the candidate

created_by

Object

Details of user who created this interview

date_created

Timestamp

Date when this interview was created

is_private

Boolean

Whether this interview is private

is_cancelled

Boolean

Whether this interview was cancelled

invitees

Array

List of details of participants (interviewers)

messages

Array

List of messages in the conversation thread for a particular interview

List all Interviews

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/interviews
curl -u {api_key}: https://api.recruiterbox.com/v2/interviews -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Filter by candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/interviews
curl -u {api_key}: https://api.recruiterbox.com/v2/interviews?candidate_id=0 -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

candidate_id
int64

List interviews for this candidate

 

Get Interview Details

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/interviews/id
curl -u {api_key}: https://api.recruiterbox.com/v2/interviews/id -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Path Params

id
string
required
 

Reviews

 

Fetch all candidate reviews

Field
Type
Description

id

Integer

Unique ID for this record

candidate

Object

Details of the candidate for which review was requested

reviewers

Array

List of user details from whom a review was requested

date_created

Timestamp

Timestamp when review was requested

submitted_reviews

Array

List of details of submitted reviews

Schema for submitted review feedback

Field
Type
Description

rating

Integer

Ranging from -2 to +2 (Strongly No, No, Neutral, Yes, Strong Yes)

feedback_text

String

Elaborate comment for why a particular rating was given

submitted_by

Object

Details of user who submitted feedback

date_created

Timestamp

Timestamp indicating when the feedback was given

date_modified

Timestamp

Timestamp indicating when the feedback was modified (if at all)

List all Reviews

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/reviews
curl -u {api_key}: https://api.recruiterbox.com/v2/reviews -H "Content-Type: application/json"
A binary file was returned
{
  "objects": [
    {
      "submitted_reviews": [
        {
          "feedback_text": "Good",
          "rating": 1,
          "date_created": 1484892949,
          "submitted_by": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          },
          "date_modified": 1484892949
        }
      ],
      "candidate": {
        "id": 19
      },
      "reviewers": [
        {
          "name": "User 0",
          "email": "soemaccount@company_name.com"
        }
      ],
      "comments": [
        {
          "message": "Note",
          "sender": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          }
        }
      ],
      "requested_by": {
        "name": "User 0",
        "email": "soemaccount2@company_name.com"
      },
      "id": 1
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Filter by Candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/reviews
curl -u {api_key}: https://api.recruiterbox.com/v2/reviews -H "Content-Type: application/json"
A binary file was returned
{
  "objects": [
    {
      "submitted_reviews": [
        {
          "feedback_text": "Good",
          "rating": 1,
          "date_created": 1484892949,
          "submitted_by": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          },
          "date_modified": 1484892949
        }
      ],
      "candidate": {
        "id": 19
      },
      "reviewers": [
        {
          "name": "User 0",
          "email": "soemaccount@company_name.com"
        }
      ],
      "comments": [
        {
          "message": "Note",
          "sender": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          }
        }
      ],
      "requested_by": {
        "name": "User 0",
        "email": "soemaccount2@company_name.com"
      },
      "id": 1
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Query Params

candidate_id
int32

Candidate by which filter reviews

 

Read a Review

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/reviews/id
curl -u {api_key}: https://api.recruiterbox.com/v2/reviews/id -H "Content-Type: application/json"
A binary file was returned
{
      "submitted_reviews": [
        {
          "feedback_text": "Good",
          "rating": 1,
          "date_created": 1484892949,
          "submitted_by": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          },
          "date_modified": 1484892949
        }
      ],
      "candidate": {
        "id": 19
      },
      "reviewers": [
        {
          "name": "User 0",
          "email": "soemaccount@company_name.com"
        }
      ],
      "comments": [
        {
          "message": "Note",
          "sender": {
            "name": "User 0",
            "email": "soemaccount@company_name.com"
          }
        }
      ],
      "requested_by": {
        "name": "User 0",
        "email": "soemaccount2@company_name.com"
      },
      "id": 1
    }

Path Params

id
int32
required
 

Evaluations

 

Fetch all candidate evaluations i.e. interview feedback as well as structured evaluations.

Field
Type
Description

id

Integer

Unique ID for this record

feedback

Array

List of feedback submitted for an interview

Feedback Schema

Field
Type
Description

rating

Integer

Ranging from -2 to +2 (Strongly No, No, Neutral, Yes, Strong Yes)

feedback_text

String

Elaborate comment for why a particular rating was given

criteria

String

Criteria for which feedback was given E.g. Communication Skills or Overall

submitted_by

Object

Details of user who submitted feedback

date_submitted

Timestamp

Timestamp indicating when the feedback was given

attachments

Array

List of { file_name: "", url: ""}. Available only when criteria is Overall

List all Evaluations

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/evaluations
curl -u {api_key}: https://api.recruiterbox.com/v2/evaluations -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Filter by Candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/evaluations
curl -u {api_key}: https://api.recruiterbox.com/v2/evaluations?candidate_id=0 -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

candidate_id
int64

List evaluations for this candidate

interview_id
int64

List evaluations for this interview

 

To-dos

 

Fetch all to-do items from accessible candidate profiles

Field
Type
Description

id

Integer

Unique ID for the record

title

String

Title for to-do

date_due

Timestamp

Date when to-do is due

is_done

Boolean

Whether to-do was marked complete

assigned_to

Array

User(s) to which this to-do item was assigned

comments

Array

Any comments on this to-do item

List all To-dos

Allows you fetch all accessible to-do's

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/todos
curl -u {api_key}: https://api.recruiterbox.com/v2/todos 
A binary file was returned
{
  "objects": [
    {
      "candidate": {
        "id": 1253437445
      },
      "messages": [
        {
          "body": "",
          "date": 1483308642,
          "id": 137346270,
          "sender": {
            "name": "Jaydon Sanford",
            "email": "jay@acme.com"
          },
          "subject": ""
        }
      ],
      "id": 223382,
      "is_private": false,
      "assigned_to": [
        {
          "name": "Jaydon Sanford",
          "email": "jay@acme.com"
        },
        {
          "name": "Lailah Woodward",
          "email": "laliah@acme.com"
        }
      ]
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

Query Params

offset
int32

Starting position from which to fetch objects

limit
int32

A limit on the number of objects returned

 

Filter by candidate

Fetch all to-do's for a specific candidate

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/todos
curl -u {api_key}: https://api.recruiterbox.com/v2/todos?candidate_id=0 -H "Content-Type: application/json"
A binary file was returned
Try the API to see results

Query Params

candidate_id
string
required
 

Read a To-do

Get details for a specific to-do item

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.recruiterbox.com/v2/todos/id
curl -u {api_key}: https://api.recruiterbox.com/v2/todos/id
A binary file was returned
Try the API to see results

Path Params

id
int32
required