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));

{
  "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,
      "invite_config": {
        "custom_message": "<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": {
        "participants": [
          "<string>"
        ],
        "interview_date": "2023-12-25",
        "error": "<string>"
      },
      "campaign": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "first_message_preview": "<string>",
      "message_count": 123,
      "topics_total": 123,
      "topics_done": 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."
}

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));

{
  "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,
      "invite_config": {
        "custom_message": "<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": {
        "participants": [
          "<string>"
        ],
        "interview_date": "2023-12-25",
        "error": "<string>"
      },
      "campaign": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "first_message_preview": "<string>",
      "message_count": 123,
      "topics_total": 123,
      "topics_done": 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

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

Query Parameters

assigned_to

enum<string>

Set to "me" to return only interviews assigned to (or created by) the requesting user.

Available options:

me

created_by

enum<string>

Set to "me" to return only interviews the requesting user created (whoever they were assigned to).

Available options:

me

status

string

Filter by status. Comma-separated for multiple values (e.g. "pending,in_progress").

campaign

string

Filter by campaign: a campaign UUID for that campaign's interviews, or the literal "none" for interviews without a campaign.

text

string

Case-insensitive search over the interview name and transcript.

limit

integer

default:100

Maximum number of results per page

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of results to skip for pagination

Required range: x >= 0

Response

Successful response

count

integer

Total number of results

string<uri> | null

URL to next page of results

string<uri> | null

URL to previous page of results

results

object[]

Show child attributes

status_counts

object

Number of interviews per status across the whole filtered set (not just the returned page). Keys are the status values ("pending", "in_progress", "completed"); legacy conversations without a status are counted under "none". Absent keys mean zero.

Show child attributes

Retrieve conversation feedback Create and assign interviews

Concepts

Endpoints

List interviews

Authorizations

Path Parameters

Query Parameters

Response