List started widget chat conversations across every site for admins

GET

/product/chat/conversations

Authorizations

BearerAuth

JWT token from login

Type

HTTP (bearer)

or

AccessToken

Personal access token. Value: Token <your-token>

Type

API Key (header: Authorization)

Parameters

Query Parameters

status

Type

string

Valid values

"all""waiting""open""closed"

site

Type

string

q

Search message text, attachment filenames, page context, notes, and customer identity. Search includes closed chats.

Type

string

limit

Type

integer

Default

200

Maximum

300

Responses

OK

Content-Type

application/json

{

  

"items": [

  

],

  

"counts": {

  

}

}

GET

/product/chat/conversations

Playground

Authorization

BearerAuth

Variables

Key

Value

status

site

q

limit

Samples

Powered by VitePress OpenAPI