Skip to main content
GET
/
customers
/
{customerId}
Get Customer
curl --request GET \
  --url https://www.withvayu.org/customers/{customerId} \
  --header 'Authorization: Bearer <token>'
{
  "customer": {
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "aliases": [],
    "contacts": [
      {
        "name": "<string>",
        "email": "[email protected]",
        "title": "<string>",
        "phone": "<string>",
        "receiveInvoiceEmail": true
      }
    ],
    "source": "Stripe",
    "taxId": "<string>",
    "externalId": "<string>",
    "customerErpId": "<string>",
    "address": {
      "country": "<string>",
      "city": "<string>",
      "addressText": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    },
    "salesForceAccountId": "<string>",
    "dueDays": "END_OF_MONTH",
    "customFields": [
      {
        "vayuCustomFieldName": "<string>",
        "valueType": "String",
        "integrationSource": "NetSuite",
        "integrationEntityType": "<string>",
        "fieldPath": "<string>",
        "value": "<unknown>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

customerId
string
required

Response

response contains the customer matching the provided externalId

customer
object
required