GET /admin/api/{api_version}/customers/search.json
Searches for customers that match a supplied query. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see
Making requests to paginated REST Admin API endpoints
.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
order |
String | No |
Set the field and direction by which to order results.(default: last_order_date DESC) |
query |
String | No |
Text to search for in the shop's customer data. |
limit |
String | No |
The maximum number of results to show.(default: 50)(maximum: 250) |
fields |
String | No |
Show only certain fields, specified by a comma-separated list of field names. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.