GET
/
interview
curl --request GET \
  --url https://api.thoughtly.com/interview \
  --header 'team_id: <api-key>' \
  --header 'x-api-token: <api-key>'
{
  "error": {},
  "data": {}
}

Authorizations

​
x-api-token
string
header
required

API key for the user making the request. This can be found via the Developer Settings page in the dashboard.

​
team_id
string
header
required

Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.

Query Parameters

​
search
string

Search term to filter Agents by title, name, or other relevant properties.

​
status
enum<string>

Filter Agents by their current status. Choose either 'ACTIVE' or 'ARCHIVED'.

Available options:
ACTIVE,
ARCHIVED
​
sort
enum<string>

Specify the field to sort the Agents by, such as 'title' or 'created date'.

Available options:
title_asc,
title_desc,
created_asc,
created_desc
​
all_interviews
boolean

Set to true to return all Agents, including archived ones.

​
page
integer

Specify the page of results to retrieve (pagination).

Required range: x >= 0
​
limit
integer
default:20

Specify the maximum number of Agents to return per page (pagination). The default is 20.

Required range: 1 <= x <= 50

Response

200 - application/json
Successful response

The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.

​
data
object
required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.

​
error
object | null

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

Was this page helpful?