Retrieve customer

GET

/v2/customers/{customer_id}

Returns details for a single customer.

Permissions:CUSTOMERS_READ

Guide

Retrieve the customer profile of a given ID

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

customer_id

string

Required

The ID of the customer to retrieve.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

customer

The requested customer.

Link to section

Examples

GET /v2/customers/{customer_id}

curl https://connect.squareup.com/v2/customers/JDKYHBWT1D4F8MFH63DBMEN8Y4 \
  -H 'Square-Version: 2023-11-15' \
  -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": "[email protected]",
    "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",
    "preferences": {
      "email_unsubscribed": false
    },
    "creation_source": "THIRD_PARTY",
    "group_ids": [
      "545AXB44B4XXWMVQ4W8SBT3HHF"
    ],
    "segment_ids": [
      "1KB9JE5EGJXCW.REACHABLE"
    ],
    "version": 1
  }
}