Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Beta
ChatKit
Threads

List ChatKit threads

$ openai beta:chatkit:threads list
GET/chatkit/threads

List ChatKit threads with optional pagination and user filters.

ParametersExpand Collapse
--after: optional string

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

--before: optional string

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

--limit: optional number

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

--order: optional "asc" or "desc"

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

--user: optional string

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

ReturnsExpand Collapse
Threads: object { data, first_id, has_more, 2 more }

A paginated list of ChatKit threads.

data: array of ChatKitThread { id, created_at, object, 3 more }

A list of items

id: string

Identifier of the thread.

created_at: number

Unix timestamp (in seconds) for when the thread was created.

object: "chatkit.thread"

Type discriminator that is always chatkit.thread.

status: object { type } or object { reason, type } or object { reason, type }

Current status for the thread. Defaults to active for newly created threads.

active: object { type }

Indicates that a thread is active.

locked: object { reason, type }

Indicates that a thread is locked and cannot accept new input.

reason: string

Reason that the thread was locked. Defaults to null when no reason is recorded.

type: "locked"

Status discriminator that is always locked.

closed: object { reason, type }

Indicates that a thread has been closed.

reason: string

Reason that the thread was closed. Defaults to null when no reason is recorded.

type: "closed"

Status discriminator that is always closed.

title: string

Optional human-readable title for the thread. Defaults to null when no title has been generated.

user: string

Free-form string that identifies your end user who owns the thread.

first_id: string

The ID of the first item in the list.

has_more: boolean

Whether there are more items available.

last_id: string

The ID of the last item in the list.

object: "list"

The type of object returned, must be list.

List ChatKit threads

openai beta:chatkit:threads list \
  --api-key 'My API Key'
{
  "data": [
    {
      "id": "cthr_abc123",
      "object": "chatkit.thread",
      "title": "Customer escalation"
    },
    {
      "id": "cthr_def456",
      "object": "chatkit.thread",
      "title": "Demo feedback"
    }
  ],
  "has_more": false,
  "object": "list"
}
Returns Examples
{
  "data": [
    {
      "id": "cthr_abc123",
      "object": "chatkit.thread",
      "title": "Customer escalation"
    },
    {
      "id": "cthr_def456",
      "object": "chatkit.thread",
      "title": "Demo feedback"
    }
  ],
  "has_more": false,
  "object": "list"
}