Search conversations

Search conversations.

Authorization

bearerToken

AuthorizationBearer <token>

Personal access tokens created from the ThriveDesk UI. Create one under Integrations -> API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Filter object passed to the search engine. Common keys: subject, status, inbox_id, assignee_id, tag_id, contact_id, from_date, to_date. Defaults to no filters.

per-page?integer

Default20

sort?string

Default"newest"

Value in

"newest"
"oldest"

Response Body

`application/json`

curl -X POST "https://example.com/search" \  -H "Content-Type: application/json" \  -d '{    "q": {      "subject": "refund",      "status": "Active"    },    "per-page": 20,    "sort": "newest"  }'

{  "success": true,  "data": {    "conversations": {}  }}

Search conversations

Authorization

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`