v1

latestOpenAPI 3.0.02026-07-1313126.3 KB

agent

Get agents

This endpoint retrieves a list of Agents (formerly Interviews) available in your system. You can filter the list by status, search term, and sorting options.

get/interview

Query parameters

searchstring

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

status'ACTIVE' | 'ARCHIVED'

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

sort'title_asc' | 'title_desc' | 'created_asc' | 'created_desc'

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

all_interviewsboolean

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

pageinteger

Specify the page of results to retrieve (pagination).

limitinteger

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

Response

Successful response

errorobject nullable

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.

dataobject 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.

All 13 operations