Skip to main content
GET
List threads

Authorizations

x-cominty-token
string
header
required

A Cominty Platform API secret. A key created now starts with sk-cmt-. Send it as is, or as Bearer sk-cmt-..., with at most one Bearer prefix. A key created before the prefix existed has no sk-cmt- and still works.

Query Parameters

user_id
string | null

End user whose threads to list. Required for an API token.

platform
enum<string> | null

Product surface of the threads. An API token always lists api sessions, so you can omit this. api sessions are what an API token can list. portal is not used with an API token.

Available options:
portal,
api
limit
integer
default:50

Page size. Defaults to 50. Maximum 100.

Required range: x <= 100
page
integer
default:0

Zero-based page index.

terms
string[]

Free-text search terms. At most 10 strings.

Maximum array length: 10

Response

Successful Response

id
string<uuid>
required
name
string
required
created_at
string<date-time>
required
live
boolean
required
starred
boolean
required
inception
enum<string>
required
read-only
Available options:
conversational,
routine