Get customer

This API is used to get one customer by our customer_id.

It returns the customer profile, the locations of your scope it is linked to and how many cards / bank accounts it has saved.

Note: editable: false means the customer is also linked to locations outside your key: you can read it but not update its profile.

URL

{{interface_url}}/{{version}}/customers/{{customer_id}}

Method

GET

Headers

Authorization: Bearer {access_token} (or Api-Key)

Request Parameters

None.

URL Parameters

ParameterRequired/OptionalTypeDescription
customer_idRequiredIntegerOur customer ID (id returned by Create customer).

Example Request (cURL)

curl --location '{{interface_url}}/{{version}}/customers/{{customer_id}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

Example Response (JSON) — 200

{
  "id": 48213,
  "customer_id_external": "CRM-1001",
  "first_name": "Ana",
  "last_name": "Garcia",
  "email": "[email protected]",
  "phone": "5125550134",
  "phone_country_id": 3,
  "gender": 2,
  "citizenship": null,
  "address": {
    "line1": "100 Main St",
    "line2": null,
    "city": "Austin",
    "zipcode": "78701",
    "state_id": null,
    "country_id": 3
  },
  "email_verified_at": null,
  "phone_verified_at": null,
  "status": "active",
  "editable": true,
  "locations": [
    {
      "location_id": 279685,
      "name": "Main Street",
      "linked_at": "2026-11-05T18:16:18Z"
    }
  ],
  "payment_methods_count": {
    "card": 1,
    "ach": 0
  },
  "created_at": "2026-11-05T18:16:18Z",
  "updated_at": "2026-11-05T18:16:18Z"
}

Error Responses

Format: { "error": { "code", "name", "message", "details" } }

StatusErrorWhen
404customer_not_foundWrong ID, or the customer is not in your scope.
Path Params
string
required
string
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json