Customers
List Customers
API Reference
- Customers
- Products
- Plans
- Contracts
- Invoices
- Measurements
- Auth
- Events
- Reports
- Integrations
- Credits
- Webhooks
Customers
List Customers
Get a list of Customers.
GET
/
customers
curl --request GET \
--url https://connect.withvayu.com/customers \
--header 'Authorization: Bearer <token>'
{
"customers": [
{
"name": "<string>",
"aliases": [],
"address": {
"country": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"receiveInvoiceEmail": true
}
],
"externalId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
RequestSuccess
The name of the customer
Minimum length:
1
The aliases of the customer used to match events to the customer.
The external ID of the customer
Minimum length:
1
curl --request GET \
--url https://connect.withvayu.com/customers \
--header 'Authorization: Bearer <token>'
{
"customers": [
{
"name": "<string>",
"aliases": [],
"address": {
"country": "<string>",
"city": "<string>",
"addressText": "<string>",
"state": "<string>",
"postalCode": "<string>"
},
"contacts": [
{
"name": "<string>",
"email": "jsmith@example.com",
"receiveInvoiceEmail": true
}
],
"externalId": "<string>",
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}