Skip to main content
POST
/
api
/
rest
/
customers
/
search
Search Customers
curl --request POST \
  --url https://api.upwell.com/api/rest/customers/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "offset": 0,
  "orderBy": {},
  "where": {}
}
'
{
  "customers": [
    {
      "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

Query Parameters

ā€‹
limit
integer
default:10
ā€‹
offset
integer
default:0

Body

application/json

Query parameters can also be provided in the request body as a JSON object

ā€‹
limit
integer | null
default:10
ā€‹
offset
integer | null
default:0
ā€‹
orderBy
object[] | null
ā€‹
where
CustomersBoolExp Ā· object

Boolean expression to filter rows from the table "customers". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/customers/search

ā€‹
customers
Customers Ā· object[]