Get Customer

GET /customers

Retrieve a single customer by phone or email.

Set locations=true to include the customer's locations.

Query parameters

  • phone string(phone) Required

    Phone number in E.164 international format

  • email string(email) Required

    Valid email address (only required if phone is not specified)

  • locations boolean

    Include the customer’s locations


  • 200
    Hide response attributes Show response attributes object
    • message string
    • data object
      Hide data attribute Show data attribute
      • customer object
        Hide customer attributes Show customer attributes
        • uuid string(uuid)
        • Customer's ID generated from a third-party system such as a CRM, POS, or accounting software

        • name string
        • email string(email)
        • phone string(phone)

          Customer's phone number in E.164 international format

        • type string
GET /customers
curl \
 -X GET https://{workspace} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
  "message": "success",
  "data": {
    "customer": {
      "uuid": "69e93118-a581-4a13-afea-b6d4a2d2c40c",
      "external_id": "ABCDE12345",
      "name": "John Doe",
      "email": "",
      "phone": "+12163547758",
      "type": "INDIVIDUAL",
      "locations": [
          "uuid": "84e249df-8d50-4212-8329-6059fc002563",
          "name": null,
          "line_1": "4840 Sun Valley Road",
          "line_2": "Flat 302",
          "city": "Prescott",
          "region": "Washington",
          "country": "US",
          "zip_code": "99348",
          "coordinates": {
            "lat": 46.371826,
            "lng": -118.496391