Sign in

v1

latestOpenAPI 3.0.02026-07-1313126.3 KB
agent

Search calls

Find calls made by an Agent (formerly Interview). You can filter and search calls based on various criteria.

get/interview/{interview_id}/responses

Path parameters

interview_idstring required

The ID of the Agent (formerly Interview) that made the call. This ID can be found in the URL of the Agent page.

Query parameters

searchstring

Search term to filter call responses by relevant properties.

response_tagsstring[]

Filter responses by tags associated with them.

statusstring[]

Filter responses by status (e.g., 'success', 'failure').

job_idstring

Filter responses by the associated job ID.

pageinteger

Specify the page of results to retrieve (pagination).

limitinteger

Specify the maximum number of responses 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.