Retrieve customer
GET
/v2/customers/{customer_id}
Returns details for a single customer.
Permissions
CUSTOMERS_READ
Try in API Explorer
| Name | Description |
|---|---|
customer_id
Required
|
The ID of the customer to retrieve. |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
customer
|
The requested customer. |
Examples
GET
/v2/customers/{customer_id}
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/customers/JDKYHBWT1D4F8MFH63DBMEN8Y4 \
-H 'Square-Version: 2020-09-23' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{
"customer": {
"id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
"created_at": "2016-03-23T20:21:54.859Z",
"updated_at": "2016-03-23T20:21:54.859Z",
"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"
]
}
}