younifyd
Menu

Search

Search for resources

POST/api/search

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the Search action (under Search).
  3. Fill in the fields below, then reference the result from later steps as {{search.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

typestringrequired

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...)

One ofagentcustomercustomer_profilecustomer_channelcustomer_channel_emailcustomer_channel_phonecustomers_by_phoneintegrationteamtag

querystring

Text query used to search for resources.

Default ""

sizeinteger

Maximum number of results returned.

Default 10

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

Response

Returns 201 with an object. Read it in later steps with {{search.response.data.<field>}}.

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.