List customers
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, espeically during network incidents and outages.
Query Parameters
| Name | Description |
|---|---|
cursor
|
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See the Pagination guide for more information. |
sort_field
|
Indicates how Customers should be sorted. Default: |
sort_order
|
Indicates whether Customers should be sorted in ascending ( Default: |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
customers
|
An array of |
cursor
|
A pagination cursor to retrieve the next set of results for the original query. Only present if the request succeeded and additional results are available. See the Pagination guide for more information. |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/customers \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'{
"customers": [
{
"id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"created_at": "2016-03-23T20:21:54.859Z",
"updated_at": "2016-03-23T20:21:55Z",
"given_name": "Amelia",
"family_name": "Earhart",
"email_address": "Amelia.Earhart@example.com",
"address": {
"address_line_1": "500 Electric Ave",
"address_line_2": "Suite 600",
"locality": "New York",
"administrative_district_level_1": "NY",
"postal_code": "10003",
"country": "US"
},
"phone_number": "1-212-555-4240",
"reference_id": "YOUR_REFERENCE_ID",
"note": "a customer",
"groups": [
{
"id": "545AXB44B4XXWMVQ4W8SBT3HHF",
"name": "Aviation Enthusiasts"
},
{
"id": "1KB9JE5EGJXCW.REACHABLE",
"name": "Reachable"
}
],
"group_ids": [
"545AXB44B4XXWMVQ4W8SBT3HHF"
],
"segment_ids": [
"1KB9JE5EGJXCW.REACHABLE"
]
}
]
}