ListCustomers
Lists customer profiles associated with a Square account.
Under normal operating conditions, newly created or updated customer profiles become available for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated profiles can take closer to one minute or longer, especially during network incidents and outages.
Query parameters
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.
The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than 1 or greater than 100. The default value is 100.
For more information, see Pagination.
Indicates how customers should be sorted.
The default value is DEFAULT.
Indicates whether customers should be sorted in ascending (ASC) or descending (DESC) order.
The default value is ASC.
Response
Success
Example response
{
"customers": [
{
"address": {
"address_line_1": "500 Electric Ave",
"address_line_2": "Suite 600",
"administrative_district_level_1": "NY",
"country": "US",
"locality": "New York",
"postal_code": "10003"
},
"created_at": "2016-03-23T20:21:54.859Z",
"creation_source": "THIRD_PARTY",
"email_address": "Amelia.Earhart@example.com",
"family_name": "Earhart",
"given_name": "Amelia",
"group_ids": [
"545AXB44B4XXWMVQ4W8SBT3HHF"
],
"id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"note": "a customer",
"phone_number": "1-212-555-4240",
"preferences": {
"email_unsubscribed": false
},
"reference_id": "YOUR_REFERENCE_ID",
"segment_ids": [
"1KB9JE5EGJXCW.REACHABLE"
],
"updated_at": "2016-03-23T20:21:55Z",
"version": 1
}
]
}