List ChatKit threads | Sample

5 parameters

limitintegeroptional

Maximum number of thread items to return. Defaults to 20.

orderstringoptional

Sort order for results by creation time. Defaults to `desc`.

Allowed:ascdesc

afterstringoptional

List items created after this thread item ID. Defaults to null for the first page.

beforestringoptional

List items created before this thread item ID. Defaults to null for the newest results.

userstringoptional

Filter threads that belong to this user identifier. Defaults to null to return all users.

1 status code

200Success

objectstringrequired

The type of object returned, must be `list`.

Allowed:listDefault:list

dataarray<TheThreadObject>required

A list of items

first_idstringrequired

The ID of the first item in the list.

last_idstringrequired

The ID of the last item in the list.

has_morebooleanrequired

Whether there are more items available.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.threads.list({
  limit: 20,
  order: "example",
  after: "example",
  before: "example",
  user: "octocat",
});

{
  "object": "list",
  "data": [
    {
      "id": "cthr_def456",
      "object": "chatkit.thread",
      "created_at": 1712345600,
      "title": "Demo feedback",
      "status": {
        "type": "active"
      },
      "user": "user_456"
    }
  ],
  "first_id": "550e8400-e29b-41d4-a716-446655440000",
  "last_id": "550e8400-e29b-41d4-a716-446655440000",
  "has_more": true
}

Request

Response