Skip to main content
POST
Search tickets

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

Body

application/json
query
string
required

Free-text search terms, matched against ticket messages.

Required string length: 1 - 512
Example:

"refund not received"

limit
integer
default:20

Number of results to return (1 to 50, default 20)

Required range: 1 <= x <= 50
Example:

20

Response

Ranked search results

data
object[]
required
pagination
object
required