Skip to main content
GET
/
customers
/
name
/
{name}
Get customer by name
curl --request GET \
  --url https://connect.withvayu.com/customers/name/{name} \
  --header 'Authorization: Bearer <token>'
{
  "customer": {
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "aliases": [],
    "address": {
      "country": "<string>",
      "city": "<string>",
      "addressText": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    },
    "contacts": [
      {
        "name": "<string>",
        "email": "[email protected]",
        "title": "<string>",
        "phone": "<string>",
        "receiveInvoiceEmail": true
      }
    ],
    "source": "Stripe",
    "externalId": "<string>",
    "customerErpId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
name
string
required

Response

response contains the customer matching the provided name

​
customer
object
required

The customer matching the provided name