Skip to main content
GET
/
api
/
rest
/
customers
/
{id}
Get One Customer
curl --request GET \
  --url https://api.upwell.com/api/rest/customers/{id}
{
  "customer": {
    "addresses": [
      {
        "city": "<string>",
        "country": "AD",
        "id": "<string>",
        "stateOrProvince": "<string>",
        "streetLine1": "<string>",
        "streetLine2": "<string>",
        "type": "ADDRESS_BOOK",
        "zipOrPostalCode": "<string>"
      }
    ],
    "balance": 123,
    "billToCustomerId": "<string>",
    "ccEmailAddresses": [
      "<string>"
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "customerRule": {
      "dueOption": 123,
      "id": "<string>"
    },
    "emailAddress": "<string>",
    "id": "<string>",
    "metadata": "<unknown>",
    "name": "<string>",
    "overdueBalance": 123,
    "overdueInvoiceCount": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Path Parameters

​
id
string
required

"id" is required (enter it either in parameters or request body)

Response

200 - application/json

Responses for GET /api/rest/customers/{id}

​
customer
Customers · object

columns and relationships of "customers"