Skip to main content
GET
/
v1
/
interviews
Get interviews
curl --request GET \
  --url https://app.ribbon.ai/be-api/v1/interviews \
  --header 'Authorization: Bearer <token>'
{
  "interviews": [
    {
      "interview_flow_id": "<string>",
      "interview_id": "<string>",
      "team_id": "<string>",
      "status": "incomplete",
      "interview_data": {
        "transcript": "<string>",
        "transcript_with_timestamp": [
          {
            "content": "<string>",
            "role": "<string>",
            "words": [
              {
                "end": 123,
                "start": 123,
                "word": "<string>"
              }
            ]
          }
        ],
        "questions_to_transcript_mapping": [
          {
            "script_question": "<string>",
            "transcript_item_indices": [
              123
            ],
            "start_timestamp": 123,
            "end_timestamp": 123,
            "transcript_items": [
              {
                "content": "<string>",
                "role": "<string>"
              }
            ]
          }
        ],
        "audio_url": null,
        "video_url": null,
        "summary": null,
        "scores": {
          "communication": null,
          "motivation": null,
          "skills": null,
          "language_vocabulary_and_expression": null,
          "language_grammar_and_structure": null,
          "language_fluency_and_pace": null,
          "language_comprehension": null
        },
        "interviewee_email_address": null,
        "interviewee_first_name": null,
        "interviewee_last_name": null
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ribbon.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Query Parameters

​
limit
integer
default:20

The number of interviews to return.

​
offset
integer
default:0

The offset for the list of interviews.

​
status
enum<string>
default:completed

The status of the interviews to return.

Available options:
incomplete,
completed
​
team_id
string | null

Filter interviews by team ID. If not provided, returns interviews for all teams in the organization.

Response

OK

​
interviews
object[]
required

A list of interviews.