Sign in
latestOpenAPI 3.1.02026-07-24111290748.0 KB

36f2e31f4e81

Search

Search for resources

post/api/search

Request body

type'agent' | 'customer' | 'customer_profile' | 'customer_channel' | 'customer_channel_email' | 'customer_channel_phone' | 'customers_by_phone' | 'integration' | 'team' | 'tag' required

The type of search. Supported types:

  • customer: Search in customers' names and emails
  • customer_profile: Search in customers' names, emails, and channels' addresses (phones, emails, etc...)
querystring

Text query used to search for resources.

sizeinteger

Maximum number of results returned.

Example request

{
  "type": "agent",
  "query": "user@example.com",
  "size": 10
}

Response

List of the found resources.

object required