Projects¶

Projects may also be referred to as interviews throughout the interview suite and documentation.

Please read about the Project workflow before diving into this page.

Attributes

Name	Type	Description
resource_uri	reference	read only
company	reference	read only
name	string
job_url	string	optional, link to the public job listing for the position
email_alias	string	optional, emails that are automatically sent to candidates will have this address as sender
mode	string
maximum_score	integer
support_lang	string	Emails that are automatically sent to candidates will use this language, as will the candidate interface when undertaking the interview. See languages for available language codes, which differ by company. Leave blank to use the company’s default project language (see company settings).
language	string	read only iso compliant language code for support_lang
status	string	read only Must be changed with the Update Status Action. See more.
internal_id	string	optional
allow_hash_login	bool	optional
max_interview_time	integer	optional
invite_candidates	bool	optional
default_interview_period	integer	optional
closedate	date	optional
activationdate	date	optional
contact_person	string	optional
creationdate	date	optional
veto_enabled	bool	optional
status_update_uri	reference	read only
evaluators	list	list of customers URIs, indicating customers who are evaluators in this project. supports nested loading
interview_managers	list	list of customers URIs, indicating customers who are managers in this project.
reviewers	list	list of customers URIs, indicating customers who are reviewers in this project.
labels	list	list of labels URIs
questions	reference	read only, supports nested loading
candidates	reference	read only
results	reference	read only
roles	reference	read only, supports nested loading
criteria	reference	read only, supports nested loading
videos	reference	Returns an array of json objects that each contain a welcome video id under the key ‘uri’ and the position of that welcome video under the key ‘position’. This indicates which welcome videos (out of the welcome videos available on the project resource) are a part of the project and the order in which these videos are presented both to the candidate and to the customer. Interview managers can modify the display order of the welcome videos.
can_evaluate	bool	read only. Returns true if project can be evaluated by requesting user. That means the user is enabled as Evaluator in such project and the project itself contains at least 1 interviewed candidate.
can_see_results	bool	read only. Returns true if project can show results of interviewed candidates. Only those candidates which were fully evaluated by at least 1 evaluator can show results. If requesting user is an evaluator, they must have finished their evaluation of such candidate.
can_archive	bool	read only. Returns true if project status can be set to `60-closed`. Such a project must have no candidates in statuses `invited`, `confirmed`, `interviewing` and the all `interviewed` candidates are fully evaluated.
candidates_count	integer	read only. Returns the amount of candidates.
interviewed_candidates_count	integer	read only. Returns the amount of interviewed candidates in this project.
expired_candidates_count	integer	read only. Returns the amount of expired candidates in this project.
invited_candidates_count	integer	read only. Returns the amount of invited candidates in this project.
confirmed_candidates_count	integer	read only. Returns the amount of confirmed candidates in this project.
interviewing_candidates_count	integer	read only. Returns the amount of interviewing candidates in this project.
aborted_candidates_count	integer	read only. Returns the amount of aborted candidates in this project.
evaluated_candidates_count	integer	read only. Returns the amount of evaluated candidates in this project.
skipped_candidates_count	integer	read only. Returns the amount of ‘skipped’ candidates in this project.
partner_data	object	this field is for internal use and provides no additional functionality
team_evaluation	integer	number of evaluators that are required to fully evaluate a candidate so its evaluation status can be considered “completed”. optional, defaults to 0. can be set to 0, 1 or 2, and 0 means all evaluators.
interview_suite_url	string	read only The URL that leads directly to the appropriate interview suite page for this record

List¶

/companies/{{companyId}}/projects/[?status=<status>]

Methods¶

GET
POST

Notes¶

it is possible to retrieve a list of projects filtered by status by using the status querystring parameter, possible values are:
- 10-incomplete (draft)
- 40-running (active)
- 60-closed (archived)

Example response¶

{"meta":{
    "total_count":6,
    "previous":null,
    "next":"https://interview-suite.com/api/v3/companies/1/projects/?page=2&page_size=1"
 },
 "objects":[
    {"candidates":"https://interview-suite.com/api/v3/companies/1/projects/1/candidates/",
     "closedate":null,
     "company":"https://interview-suite.com/api/v3/companies/1/",
     "creationdate":"2015-04-07",
     "default_interview_period":null,
     "internal_id":null,
     "job_url":null,
     "mode":"rolling",
     "name":"Jack/Jill-of-All-Trades #1",
     "partner_data":{},
     "questions":"https://interview-suite.com/api/v3/companies/1/projects/1/questions/",
     "resource_uri":"https://interview-suite.com/api/v3/companies/1/projects/1/",
     "status":"10-incomplete",
     "support_lang":"en",
     "language": "en-GB",
     "contact_person":null,
     "max_interview_time":0,
     "videos":[
        {
          "uri": "https://interview-suite.com/api/v3/companies/1/videos/1/",
          "position": 1
        },
        {
          "uri": "https://interview-suite.com/api/v3/companies/1/videos/2/",
          "position": 2
        }
     ],
     "labels": [
       "https://interview-suite.com/api/v3/companies/1/labels/7/",
       "https://interview-suite.com/api/v3/companies/1/labels/8/"
     ],
     "maximum_score":5,
     "allow_hash_login":false,
     "invite_candidates":true,
     "results":"https://interview-suite.com/api/v3/companies/1/projects/1/results/",
     "roles":"https://interview-suite.com/api/v3/companies/1/projects/1/roles/",
     "can_evaluate":true,
     "can_see_results":true,
     "can_archive":true,
     "candidates_count":5,
     "interviewed_candidates_count":3,
     "expired_candidates_count":0,
     "invited_candidates_count":1,
     "confirmed_candidates_count":1,
     "interviewing_candidates_count":0,
     "aborted_candidates_count":0,
     "evaluated_candidates_count":0,
     "skipped_candiates_count":1,
     "team_evaluation": 0
     }
   ]
}

Object¶

/companies/{{companyId}}/projects/{{projectId}}/

Methods¶

GET
PATCH

Example response¶

{"candidates":"https://interview-suite.com/api/v3/companies/1/projects/1/candidates/",
 "closedate":null,
 "company":"https://interview-suite.com/api/v3/companies/1/",
 "creationdate":"2015-04-07",
 "default_interview_period":null,
 "internal_id":null,
 "job_url":"https://acme-recruit.com/listing/972512/",
 "mode":"rolling",
 "name":"Jack/Jill-of-All-Trades #1",
 "partner_data":{},
 "questions":"https://interview-suite.com/api/v3/companies/1/projects/1/questions/",
 "resource_uri":"https://interview-suite.com/api/v3/companies/1/projects/1/",
 "status":"10-incomplete",
 "support_lang":"en",
 "language": "en-GB",
 "contact_person":null,
 "max_interview_time":0,
 "videos":[],
 "maximum_score":5,
 "allow_hash_login":false,
 "invite_candidates":true,
 "results":"https://interview-suite.com/api/v3/companies/1/projects/1/results/",
 "roles":"https://interview-suite.com/api/v3/companies/1/projects/1/roles/",
 "can_evaluate":true,
 "can_see_results":true,
 "can_archive":true,
 "candidates_count":5,
 "interviewed_candidates_count":3,
 "expired_candidates_count":0,
 "invited_candidates_count":1,
 "confirmed_candidates_count":1,
 "interviewing_candidates_count":0,
 "aborted_candidates_count":0,
 "evaluated_candidates_count":0,
 "skipped_candidates_count":1
 }

Update Status Action¶

Used to change project’s status to a valid one, as that change is not allowed to the Project resource attribute “status” directly (due to permission concerns).

Attributes

Name Type Description

resource_uri reference read only

status

string

possible values:

10-incomplete (draft project)
40-running (active project)
60-closed (archived project)

/companies/{{companyId}}/projects/{{projectId}}/status/

Methods¶

GET
PATCH

Projects¶

List¶

Methods¶

Notes¶

Example response¶

Object¶

Methods¶

Example response¶

Update Status Action¶

Methods¶

Navigation

Table of Contents