Conversations

List agent conversations

GET /api/v1/agents/{agentId}/conversations

List agent conversations

Returns paginated conversation summaries for an agent configured for a company.

Parameters

Name In Type Description
agentId * path integer

Internal agent id.

cursor query string

Opaque cursor returned by the previous page.

limit query integer

Maximum number of conversations to return.

Responses

Status Schema Description
200 ConversationList

Conversation summaries for the agent

400 AgentError

Invalid query params

401 AgentError

Missing or invalid auth

403 AgentError

Caller cannot access conversations for this agent

Example 200 response
{
    "data": [
        {
            "id": 1,
            "identifier": "string",
            "title": "string",
            "resolved": true,
            "createdAt": "string",
            "updatedAt": "string",
            "messageCount": 1
        }
    ],
    "pageInfo": {
        "hasNextPage": true,
        "endCursor": "string"
    }
}
Example 400 response
{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}
Example 401 response
{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}
Example 403 response
{
    "error": "string",
    "message": "string",
    "issues": [
        {
            "path": [
                "string"
            ],
            "message": "string",
            "code": "string"
        }
    ]
}