Skip to main content
GET
/
interactions
List Interactions
curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/interactions \
  --header 'Authorization: <api-key>'
{
  "interactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modality": "voice",
      "status": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "transcripts": [
        {
          "text": "<string>",
          "role": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "function_name": "<string>",
          "arguments": {}
        }
      ],
      "language": "en",
      "from_number": "<string>",
      "to_number": "<string>",
      "transferred": true,
      "direction": "<string>",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "description": "<string>",
          "color": "<string>"
        }
      ],
      "ended_at": "2023-11-07T05:31:56Z",
      "duration": 123,
      "external_identifiers": {},
      "params": {},
      "recording_presigned_url": "<string>",
      "answered_by": "voicemail",
      "analyzers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {
            "type": "string",
            "properties": {}
          }
        }
      ],
      "analysis_results": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "analyzer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "prompt": "<string>",
          "output_config": {},
          "result": {}
        }
      ],
      "summary": {}
    }
  ],
  "total_count": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123,
  "filters": {
    "status": "<string>",
    "modality": "voice",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transferred": true,
    "created_at_gte": "2023-11-07T05:31:56Z",
    "created_at_lte": "2023-11-07T05:31:56Z"
  },
  "sorting": {
    "sort_by": "<string>",
    "sort_direction": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
page
integer | null
default:1
​
page_size
integer | null
default:20
​
status
string

Filter by interaction status. Multiple values can be provided separated by commas.

​
modality
enum<string>

Filter by interaction modality (voice or text)

Available options:
voice,
text
​
agent_id
string

Filter by agent group UUID. Multiple values can be provided separated by commas. Returns interactions from all versions of the specified agent(s).

​
agent_version_id
string<uuid>

Filter by specific agent version UUID. Returns interactions from only the specified agent version.

​
transferred
boolean

Filter by whether the interaction was transferred

​
created_at_gte
string<date-time>

Filter interactions created at or after this datetime (ISO 8601 format)

​
created_at_lte
string<date-time>

Filter interactions created at or before this datetime (ISO 8601 format)

​
sort_by
enum<string>
default:created_at

Field to sort results by

Available options:
created_at,
updated_at,
started_at,
ended_at,
duration,
status
​
sort_direction
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

Successful Response

​
interactions
InteractionDetailsResponse · object[]
required
​
total_count
integer
required
​
page
integer
required
​
page_size
integer
required
​
total_pages
integer
required
​
filters
Filters · object
​
sorting
Sorting · object