GET /admin/api/{api_version}/customers.json

Retrieves a list of customers. 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

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
updated_at_min String No

Show customers last updated after a specified date.
(format: 2014-04-25T16:15:47-04:00)

limit String No

The maximum number of results to show.(default: 50)(maximum: 250)

created_at_max String No

Show customers created before a specified date.
(format: 2014-04-25T16:15:47-04:00)

since_id String No

Restrict results to those after the specified ID.

fields String No

Show only certain fields, specified by a comma-separated list of field names.

ids String No

Restrict results to customers specified by a comma-separated list of IDs.

created_at_min String No

Show customers created after a specified date.
(format: 2014-04-25T16:15:47-04:00)

updated_at_max String No

Show customers last updated before a specified date.
(format: 2014-04-25T16:15:47-04:00)

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.