Skip to main content
GET
/
v1
/
threads
List Message Threads
curl --request GET \
  --url https://{api_endpoint}/api/v1/threads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "<string>",
      "created_by": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "status": "ready",
      "tenant_name": "<string>",
      "title": "<string>",
      "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "knowledge_base_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by_username": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_by": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer | null

Limit the number of results returned Limit the number of results returned

Required range: x >= 1
​
offset
integer | null

Skip the first N results Skip the first N results

Required range: x >= 0
​
agent_id
string | null

Filter threads by agent ID Filter threads by agent ID

Response

Successful Response

  • ThreadResponseWithPagination · object
  • Thread · object[]
​
data
Thread · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required