Sign in

List ChatKit threads

List ChatKit threads with optional pagination and user filters.

get/chatkit/threads

Query parameters

limitinteger

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

order'asc' | 'desc'

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

afterstring

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

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

beforestring

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

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

userstring

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

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

Response

Success

object'list' required

The type of object returned, must be list.

first_idstring nullable required

The ID of the first item in the list.

last_idstring nullable required

The ID of the last item in the list.

has_moreboolean required

Whether there are more items available.

Example response

{
  "data": [
    {
      "id": "cthr_def456",
      "object": "chatkit.thread",
      "created_at": 1712345600,
      "title": "Demo feedback",
      "status": {
        "type": "active"
      },
      "user": "user_456"
    }
  ]
}

Changes

Changed in 2 of the 163 revisions of this API.4

  • d86203de41ae3See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 74cbcf73838f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog