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",
"can_edit": true,
"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,
"invite_config": {
"custom_message": "<string>",
"custom_focus": "<string>",
"scheduled_send_at": "2023-11-07T05:31:56Z",
"invitation_email_sent_at": "2023-11-07T05:31:56Z",
"reminders_enabled": true,
"reminder_start_after_days": 123,
"reminder_interval_days": 123,
"reminder_max_count": 123,
"reminders_sent": 123,
"next_reminder_at": "2023-11-07T05:31:56Z",
"reminders_stopped": true
},
"import_info": {
"import_status": "parsing",
"participants": [
"<string>"
],
"interview_date": "2023-12-25",
"error": "<string>"
},
"meeting_info": {
"meeting_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "google_meet",
"participants": [
{
"id": "<string>",
"name": "<string>",
"is_host": true
}
],
"duration_ms": 123,
"started_at": "2023-11-07T05:31:56Z",
"url": "<string>"
},
"status": "pending",
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"first_message_preview": "<string>",
"message_count": 123,
"topics_total": 123,
"topics_done": 123,
"planned_minutes": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status_counts": {}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}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 (a campaign sorts by its own creation date, a campaign-less interview by its own) — which is what lets clients render collapsible campaign groups across pages.
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",
"can_edit": true,
"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,
"invite_config": {
"custom_message": "<string>",
"custom_focus": "<string>",
"scheduled_send_at": "2023-11-07T05:31:56Z",
"invitation_email_sent_at": "2023-11-07T05:31:56Z",
"reminders_enabled": true,
"reminder_start_after_days": 123,
"reminder_interval_days": 123,
"reminder_max_count": 123,
"reminders_sent": 123,
"next_reminder_at": "2023-11-07T05:31:56Z",
"reminders_stopped": true
},
"import_info": {
"import_status": "parsing",
"participants": [
"<string>"
],
"interview_date": "2023-12-25",
"error": "<string>"
},
"meeting_info": {
"meeting_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "google_meet",
"participants": [
{
"id": "<string>",
"name": "<string>",
"is_host": true
}
],
"duration_ms": 123,
"started_at": "2023-11-07T05:31:56Z",
"url": "<string>"
},
"status": "pending",
"campaign": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"first_message_preview": "<string>",
"message_count": 123,
"topics_total": 123,
"topics_done": 123,
"planned_minutes": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"status_counts": {}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Query Parameters
Filter by conversation type. interview returns every interview type
(standard, guided, onboarding, imported) and no meetings; meeting
returns the meetings Clara attended (present only once the call is over
and transcribed — a live meeting has no conversation yet); any other value
is matched exactly (e.g. imported-interview, onboarding). Omitting it
lists everything except meetings and Clara Fast sessions, which have their
own pages; both remain retrievable by id.
Sort order. Omit for the default: newest first, where an interview in a campaign sorts by its campaign's creation date (keeping a campaign's interviews together) and a campaign-less one by its own.
status sorts unfinished interviews first and completed ones last,
newest first within each — intended for listing one campaign's
interviews, where "who still hasn't finished" is the question.
status Response
Successful response