Skip to main content
GET
Chats list

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

limit
integer
default:10

Number of items to return (1-20, default: 10)

Required range: 1 <= x <= 20
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0
order
enum<string>
default:recent

Sort order: recent (newest first) or old (oldest first)

Available options:
recent,
old
filter
enum<string>

Filter chats by type

Available options:
priority,
who_tipped,
unread
query
string

Search/filter text

Maximum string length: 100
userListId
integer

Filter to specific user list

Required range: x > 0

Response

Successful response

list
object[]
required
hasMore
boolean
required
nextOffset
number