Skip to main content
GET
/
v1
/
interviews
List Interviews
curl --request GET \
  --url https://api.ontora.com/v1/interviews \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "goal": "<string>",
    "agent_behavior": "<string>",
    "status": "<string>",
    "channel": "<string>",
    "completion_threshold": 123,
    "timeframe_start": "2023-11-07T05:31:56Z",
    "timeframe_end": "2023-11-07T05:31:56Z",
    "interview_order": "<string>",
    "interview_duration_minutes": 123,
    "created_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "start_immediately": true,
    "scheduling_mode": "availability",
    "quick_mode_hours": 123,
    "weekly_availability": {},
    "project_context": "<string>",
    "success_criteria": "<string>",
    "interview_context_for_employee": "<string>",
    "interview_type": "<string>",
    "welcome_screen": "<string>",
    "closing_message": "<string>",
    "folder": "<string>",
    "recurring_interval": "<string>",
    "contact_count": 0,
    "completed_count": 0,
    "scheduled_count": 0
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.ontora.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-API-Key
string | null

Query Parameters

​
workspace_id
string<uuid>
required
​
project_id
string<uuid> | null
​
status
string | null

Response

Successful Response

​
id
string<uuid>
required
​
workspace_id
string<uuid>
required
​
project_id
string<uuid> | null
required
​
name
string
required
​
description
string | null
required
​
goal
string | null
required
​
agent_behavior
string | null
required
​
status
string
required
​
channel
string
required
​
completion_threshold
integer
required
​
timeframe_start
string<date-time> | null
required
​
timeframe_end
string<date-time> | null
required
​
interview_order
string
required
​
interview_duration_minutes
integer
required
​
created_by
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
timezone
string | null
​
start_immediately
boolean
default:true
​
scheduling_mode
string
default:availability
​
quick_mode_hours
integer | null
​
weekly_availability
Weekly Availability · object
​
project_context
string | null
​
success_criteria
string | null
​
interview_context_for_employee
string | null
​
interview_type
string | null
​
welcome_screen
string | null
​
closing_message
string | null
​
folder
string | null
​
recurring_interval
string | null
​
contact_count
integer
default:0
​
completed_count
integer
default:0
​
scheduled_count
integer
default:0