List customers

GET /v2/customers

Lists customer profiles associated with a Square account.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the developer dashboard Sign In

Parameters

cursor

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.

For more information, see Pagination.

string

limit

The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 100.

For more information, see Pagination.

integer

sort_field

Indicates how customers should be sorted.

The default value is DEFAULT.

string

Select sort_field

DEFAULT Use the default sort key. By default, customers are sorted alphanumerically by concatenating their given_name and family_name. If neither name field is set, string comparison is performed using one of the remaining fields in the following order: company_name, email, phone_number.
CREATED_AT Use the creation date attribute created_at of customer profiles as the sort key.

sort_order

Indicates whether customers should be sorted in ascending (ASC) or descending (DESC) order.

The default value is ASC.

string

Select sort_order

DESC The results are returned in descending e.g., newest-first or Z-A order.
ASC The results are returned in ascending e.g., oldest-first or A-Z order.

count

Indicates whether to return the total count of customers in the count field of the response.

The default value is false.

boolean

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums