API ReferenceThreads

List thread

Retrieve threads matching the specified filters with pagination.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Query parameters

pageintegerOptionalDefaults to 1
The page number to retrieve.
page_sizeintegerOptionalDefaults to 100
The number of items per page. Maximum is 1000.
environmentstringOptional
This is controlled by the API key. A prod API key creates prod threads, test key creates test threads.

Request

This endpoint expects an object.
filtersobjectOptional

Filter criteria. See Filters API Reference.

Response

Paginated list of threads.
countinteger
Total matching threads.
nextstring or null
Next page URL.
previousstring or null
Previous page URL.
resultslist of objects

Errors

401
Unauthorized Error