OpenAI API (unofficial showcase)
GET/chatkit/threads

List ChatKit threads

List ChatKit threads with optional pagination and user filters.

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.

4 status codes
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.
400The request is invalid or the required ChatKit beta header is missing or invalid.
errorobjectrequired
404The thread specified by after was not found or is not accessible.
errorobjectrequired
429The request rate limit has been exceeded.
errorobjectrequired

Error handling

A 400 is returned: The request is invalid or the required ChatKit beta header is missing or invalid. A 404 is returned: The thread specified by after was not found or is not accessible. A 429 is returned: The request rate limit has been exceeded.