Search

Search for resources

post/api/search

Request

Base URL
https://your-domain.gorgias.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/gorgias/apis/gorgias-rest-api/docs/api/search/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 2 revisions of this API.