OptimalInterview™ API

Leverage our database of pre-recorded interview questions and coaching to deliver a custom video interviewing or training experience.

Resource URL

https://api.optimalresume.com/v1/optimal-interview/questions
Use this call to get a filtered collection of questions. The questions are returned sorted by question title.

Authentication

All API requests require authentication. When you make the API calls, you must add the access token in the ‘Authorization’ header.
Remember that access tokens have a finite lifetime. If you get a 403 Forbidden response it is most probably because your access token has expired and it is time to generate a new one. An access token can be obtained via a number of methods, each of which are covered on the authentication documentation page.
Parameter Type description
access_token
REQUIRED
string The access token used for authenticating the interview api calls

Request Parameters

Parameter Type Default Value Description
question_text
optional
string Filter results by question text
status
optional
enumerated active Filter results by question status
Possible values: active; inactive;
playlist_id
optional
string Return questions for the specified playlist.
You need to supply the unique question playlist identifier.
To get a question playlist identifier you have to make an api call to GET ALL QUESTION PLAYLISTS
coaching_id
optional
string Return questions for the specified coaching
with_coaching
optional
boolean true Include in the returned response questions that have at least one coaching
Possible values: true; false;
without_coaching
optional
boolean true Include in the returned response questions that do not have a coaching
Possible values: true; false;
question_source
optional
enumerated all Include in the returned response questions provided by OptimalResume or questions that were created within the context of the current app.
Possible values: all; optimalresume; current_app;
occupation_id
optional
string Return questions for the specified occupation ID.
To get an occupation identifier you have to make an api call to GET ALL OCCUPATIONS
occupation_title
optional
string Filter questions by occupation title
onet_soc_code
optional
string Filter questions by O*NET-SOC occupation code.
bright_outlook_criteria_id
optional
string Filter questions by bright outlook occupation filter criteria.
Get a bright outlook occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFFA as identifier
career_cluster_criteria_id
optional
string Filter questions by career cluster occupation filter criteria.
Get a career cluster occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFFr as identifier
green_economy_sector_criteria_id
optional
string Filter questions by green occupation sector criteria
Get a career green economy sector occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFFD as identifier
industry_criteria_id
optional
string Filter questions by industry criteria
Get an industry occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFFu as identifier
job_family_criteria_id
optional
string Filter questions by job family criteria
Get a job family occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFF8 as identifier
stem_discipline_criteria_id
optional
string Filter questions by STEM discipline criteria
Get a STEM discipline occupation filter id by making an api call to GET OCCUPATION FILTER TYPE DETAILS using AFFFFQ as identifier
start_date
optional
date Return questions created after the given date. Date should be formatted as YYYY-MM-DD
end_date
optional
date Return questions created before the given date. Date should be formatted as YYYY-MM-DD
sort_by
optional
enumerated question_text Sort returned results by the specified field
Possible values: question_text; create_date;
page
optional
string Return results from the specified page number

Request/Response Sample

Request URL https://api.optimalresume.com/optimal-interview/questions
Request Method GET
Header Value
Accept
application/vnd.optimal-interview.v1+json
application/hal+json
application/json
Content-Type
application/vnd.optimal-interview.v1+json
application/json

Status Codes

406 Not Acceptable
415 Unsupported Media Type
200 OK
401 Unauthorized
403 Forbidden

Headers

Header Value
Content-Type
application/vnd.optimal-interview.v1+json
application/hal+json
application/json
{ "total_items": 2708, "page_size": 25, "page_count": 109, "_links": { "self": { "href": "https://api.optimalresume.com/optimal-interview/questions?page=1" }, "first": { "href": "https://api.optimalresume.com/optimal-interview/questions" }, "last": { "href": "https://api.optimalresume.com/optimal-interview/questions?page=109" }, "next": { "href": "https://api.optimalresume.com/optimal-interview/questions?page=2" } }, "_embedded": { "questions": [ { "id": "AFFFFA", "question_text": "A music company has asked your advice on how to price a soon-to-be-released record of a new artist. How would you respond?", "question_source": { "id": "AFFFFA", "name": "Optimal Resume" }, "status": "active", "create_date": "2014-03-04T20:09:23-0500", "update_date": "2014-03-04T20:09:23-0500", "_links": { "self": { "href": "https://api.optimalresume.com/optimal-interview/questions/AFFFFA" }, "coaching": { "href": "https://api.optimalresume.com/optimal-interview/coaching?question_id=AFFFFA" }, "question_media": { "href": "https://api.optimalresume.com/optimal-interview/questions-media?question_id=AFFFFA" } } }, { "id": "AFFDoL", "question_text": "A parent has become irate over their child's report of bullying. What steps would you take to investigate and confirm this? How have you helped prevent bullying?", "question_source": { "id": "AFFFFA", "name": "Optimal Resume" }, "status": "active", "create_date": "2014-03-04T20:09:23-0500", "update_date": "2014-03-04T20:09:23-0500", "_links": { "self": { "href": "https://api.optimalresume.com/optimal-interview/questions/AFFDoL" }, "coaching": { "href": "https://api.optimalresume.com/optimal-interview/coaching?question_id=AFFDoL" }, "question_media": { "href": "https://api.optimalresume.com/optimal-interview/questions-media?question_id=AFFDoL" } } } ] } }

curl -X GET "https://api.optimalresume.com/optimal-interview/questions" \
-H "Content-Type:application/json" \
-H "Accept: application/json;" \
-H "Authorization: {OAuth2 Bearer token}"

Coming soon..

Coming soon..