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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10
Required range: x <= 1000
cursor
string

Response

200
application/json
RequestSuccess
customers
object[]
required
total
number
required
hasMore
boolean
required
nextCursor
string