Interviews
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of interviews to which applicants were invited.
URI
/api/v10/interviewsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v10/interviews | C | GET HEAD | List all interviews to which applicants were invited |
/api/v10/interviews/ID/ | R | GET HEAD | Get an interview to which an applicant was invited |
/api/v10/interviews/ID/responses/ID/ | R | GET HEAD | Download the recorded answer to an interview question (original) |
/api/v10/interviews/ID/responses/ID/ | R | GET HEAD | Download the recorded answer to an interview question (WEBM format) |
/api/v10/interviews/ID/responses/ID/ | R | GET HEAD | Download the recorded answer to an interview question (MP4 format) |
GET List interviews
List interviews to which applicants were invited that match the specified filter parameters. The number of interviews is returned in the X-Count header.
Syntax
GET /api/v10/interviews
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description | Notes |
|---|---|---|---|
byInterviewScenarioIDs | Optional | A list of interview scenario IDs. | [1] |
byInterviewStatuses | Optional | A list of interview statuses. Allowed values: invited, in progress, completed, evaluated, blocked, timeout | [1] |
Notes
Note [1]: Lists can be either comma or space separated. All list items are combined with logical OR operators, meaning an interview is included if it matches any value in the list.
Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/interviews?byInterviewScenarioIDs=1,2&byInterviewStatuses=completed"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
X-Count | 3 | The number of interviews to which applicants were invited |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of interviews was successfully returned |
Example response
Response
{
"pages": {
"total": 1,
"current": 1,
"prev": null,
"next": null,
"items": {
"current": 3,
"total": 3
}
},
"1": {
"id": 1,
"status": "evaluated",
"scenario": {
"id": 1,
"title": "Interview for Humanities department"
},
"invited": "2026-05-22T07:43:02+00:00",
"started": "2026-05-22T08:35:05+00:00",
"completed": "2026-05-22T08:35:26+00:00",
"blocked": null,
"evaluated": "2026-05-22T09:38:50+00:00",
"details": [
{
"viewed": "2026-05-22T08:35:05+00:00",
"completed": "2026-05-22T08:35:12+00:00",
"attempts": 1
},
{
"viewed": "2026-05-22T08:35:13+00:00",
"completed": "2026-05-22T08:35:19+00:00",
"attempts": 1
},
{
"viewed": "2026-05-22T08:35:20+00:00",
"completed": "2026-05-22T08:35:26+00:00",
"attempts": 1
}
],
"responses": {
"1": {
"id": 1,
"mime": "video/webm",
"size": 56999,
"duration": null,
"uploaded": "2026-05-22T08:35:12+00:00",
"transcoded": "2026-05-22T08:35:13+00:00",
"question": "Please describe your greatest academic achievement.",
"download": {
"original": "/api/v10/interviews/1/responses/1/download",
"webm": "/api/v10/interviews/1/responses/1/download/webm",
"mp4": "/api/v10/interviews/1/responses/1/download/mp4"
}
},
"2": {
"id": 2,
"mime": "video/webm",
"size": 60346,
"duration": null,
"uploaded": "2026-05-22T08:35:19+00:00",
"transcoded": "2026-05-22T08:35:21+00:00",
"question": "Please describe your plans for the next 5 years.",
"download": {
"original": "/api/v10/interviews/1/responses/2/download",
"webm": "/api/v10/interviews/1/responses/2/download/webm",
"mp4": "/api/v10/interviews/1/responses/2/download/mp4"
}
},
"3": {
"id": 3,
"mime": "video/webm",
"size": 50998,
"duration": null,
"uploaded": "2026-05-22T08:35:26+00:00",
"transcoded": "2026-05-22T08:35:27+00:00",
"question": "Please talk about a hobby that you enjoy during your free time.",
"download": {
"original": "/api/v10/interviews/1/responses/3/download",
"webm": "/api/v10/interviews/1/responses/3/download/webm",
"mp4": "/api/v10/interviews/1/responses/3/download/mp4"
}
}
}
},
"2": {
"id": 2,
"status": "in progress",
"scenario": {
"id": 2,
"title": "Interview for IT Department"
},
"invited": "2026-05-22T09:45:25+00:00",
"started": "2026-05-22T09:45:57+00:00",
"completed": null,
"blocked": null,
"evaluated": null,
"details": [
{
"viewed": "2026-05-22T09:45:57+00:00",
"completed": null,
"attempts": 1
}
],
"responses": []
},
"3": {
"id": 3,
"status": "invited",
"scenario": {
"id": 3,
"title": "Interview for Law School"
},
"invited": "2026-05-22T09:33:42+00:00",
"started": null,
"completed": null,
"blocked": null,
"evaluated": null,
"details": [],
"responses": []
}
}