Skip to main content
GET
/
v1
/
interview-flows
Get interview flows
curl --request GET \
  --url https://app.ribbon.ai/be-api/v1/interview-flows \
  --header 'Authorization: Bearer <token>'
{
  "interview_flows": [
    {
      "interview_flow_id": "<string>",
      "team_id": "<string>",
      "org_name": "<string>",
      "title": "<string>",
      "questions": [
        "<string>"
      ],
      "voice_id": "11labs-Kate",
      "language": "en-US",
      "company_logo_url": null,
      "additional_info": null,
      "additional_instructions": null,
      "interview_type": "general",
      "is_video_enabled": false,
      "is_doc_upload_enabled": false,
      "redirect_url": null,
      "webhook_url": null,
      "webhook_secret_key": null,
      "intro": null,
      "outro": null
    }
  ]
}

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:100

The number of interview flows to return.

​
offset
integer
default:0

The offset for the list of interview flows.

​
team_id
string | null

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

Response

OK

​
interview_flows
object[]
required

A list of interview flows.