curl --request GET \
--url https://api.upwell.com/api/rest/customers{
"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"
}
],
"customersAggregate": {
"aggregate": {
"avg": {
"balance": 123,
"overdueBalance": 123,
"overdueInvoiceCount": 123
},
"count": 123,
"sum": {
"balance": 123,
"overdueBalance": 123,
"overdueInvoiceCount": 123
}
}
}
}Query a list of customers
curl --request GET \
--url https://api.upwell.com/api/rest/customers{
"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"
}
],
"customersAggregate": {
"aggregate": {
"avg": {
"balance": 123,
"overdueBalance": 123,
"overdueInvoiceCount": 123
},
"count": 123,
"sum": {
"balance": 123,
"overdueBalance": 123,
"overdueInvoiceCount": 123
}
}
}
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Responses for GET /api/rest/customers
Show child attributes
Show child attributes
AD, AE, AF, AG, AL, AM, AO, AR, AT, AU, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CD, CF, CG, CH, CI, CL, CM, CN, CO, CR, CU, CV, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FM, FR, GA, GB, GD, GE, GH, GM, GN, GQ, GR, GT, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MR, MT, MU, MV, MW, MX, MY, MZ, NA, NE, NG, NI, NL, NO, NP, NR, NZ, OM, PA, PE, PG, PH, PK, PL, PR, PS, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SI, SK, SL, SM, SN, SO, SR, SS, ST, SV, SY, SZ, TD, TG, TH, TJ, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VN, VU, WS, YE, ZA, ZM, ZW ADDRESS_BOOK, CARRIER, CARRIER_BILLING, COMPANY_ADDRESS, CONTACT, CUSTOMER_BILLING, DELIVERY_RECEIPT, LUMPER_RECEIPT, SHIPMENT_CONSIGNEE, SHIPMENT_PICKUP, STOP, SUPPORTING_DOC_PARTY A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
aggregated selection of "customers"
Show child attributes
aggregate fields of "customers"
Show child attributes