List interviews
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_email": "[email protected]",
"type": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_to_email": "[email protected]",
"assigned_by_email": "[email protected]",
"is_pending_invite": true,
"import_info": {
"import_status": "parsing",
"participants": [
"<string>"
],
"interview_date": "2023-12-25",
"error": "<string>"
},
"status": "pending",
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"first_message_preview": "<string>",
"message_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Interviews
List interviews
Retrieve interviews for a project.
- Admins see all interviews in the project.
- Other members see only interviews assigned to them or that they created.
Results are ordered newest first, with interviews of the same campaign kept contiguous so clients can render campaign groups across pages.
GET
/
projects
/
{project_id}
/
interviews
/
List interviews
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interviews/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_email": "[email protected]",
"type": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assigned_to_email": "[email protected]",
"assigned_by_email": "[email protected]",
"is_pending_invite": true,
"import_info": {
"import_status": "parsing",
"participants": [
"<string>"
],
"interview_date": "2023-12-25",
"error": "<string>"
},
"status": "pending",
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"first_message_preview": "<string>",
"message_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
Query Parameters
Set to "me" to return only interviews assigned to (or created by) the requesting user.
Available options:
me Filter by status. Comma-separated for multiple values (e.g. "pending,in_progress").
Filter by campaign: a campaign UUID for that campaign's interviews, or the literal "none" for interviews without a campaign.
Case-insensitive search over the interview name and transcript.
Maximum number of results per page
Required range:
1 <= x <= 1000Number of results to skip for pagination
Required range:
x >= 0