Interview Flows
Get interview flows
Retrieve all interview flows. If team_id is not provided, returns interview flows for all teams in the organization.
GET
/
v1
/
interview-flows
Get interview flows
curl --request GET \
--url https://app.ribbon.ai/be-api/v1/interview-flows \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ribbon.ai/be-api/v1/interview-flows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ribbon.ai/be-api/v1/interview-flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ribbon.ai/be-api/v1/interview-flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ribbon.ai/be-api/v1/interview-flows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ribbon.ai/be-api/v1/interview-flows")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ribbon.ai/be-api/v1/interview-flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"message": "<string>",
"code": 123,
"status": "<string>"
}{
"code": 123,
"status": "<string>",
"message": "<string>",
"errors": {}
}{
"code": 123,
"status": "<string>",
"message": "<string>",
"errors": {}
}Authorizations
Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'
Query Parameters
The number of interview flows to return.
The offset for the list of interview flows.
Filter interview flows by team ID. If not provided, returns interview flows for all teams in the organization.
Response
OK
A list of interview flows.
Show child attributes
Show child attributes
Previous
Post interview flowCreate an interview flow. If team_id is not provided, defaults to the oldest team in the organization.
Next
⌘I
Get interview flows
curl --request GET \
--url https://app.ribbon.ai/be-api/v1/interview-flows \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.ribbon.ai/be-api/v1/interview-flows"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.ribbon.ai/be-api/v1/interview-flows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.ribbon.ai/be-api/v1/interview-flows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.ribbon.ai/be-api/v1/interview-flows"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.ribbon.ai/be-api/v1/interview-flows")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ribbon.ai/be-api/v1/interview-flows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"message": "<string>",
"code": 123,
"status": "<string>"
}{
"code": 123,
"status": "<string>",
"message": "<string>",
"errors": {}
}{
"code": 123,
"status": "<string>",
"message": "<string>",
"errors": {}
}