v356

OpenAPI 3.0.3raw.githubusercontent.com2026-08-031733562.1 MB

Customer Aliases

Get customer by alias

Retrieve the details of one of your customers using one of their aliases.

get/customers/by-alias/{alias}

Path parameters

aliasstring required

Customer alias

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

idstring required

Unique ID

createdAtstring required

Created at

legalNamestring required

Legal name

contactNamestring

Contact Name

emailstring required

Main contact email address

telephonestring

Telephone

urlstring

URL

labelstring

Label

archivedAtstring

Date and time the Customer was archived

billingEmailsstring[] required

Billing email addresses

taxStatus'TAXED' | 'TAX_EXEMPT' | 'REVERSE_CHARGED' required

Example response

{
  "id": "e309e948-088e-4d77-b654-cd85498f1555",
  "createdAt": "2022-06-28T16:47:00Z",
  "legalName": "John Doe",
  "contactName": "John Doe",
  "address": {
    "line1": "Flat 1",
    "line2": "123 Fake Street",
    "town": "New York",
    "state": "NY",
    "postcode": "AB1 2EF",
    "country": "US"
  },
  "email": "john@example.com",
  "telephone": "02010001000",
  "url": "https://example.com/",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "ID",
      "lastSynced": "2022-06-28T16:47:00Z",
      "isPending": false
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9",
      "lastSynced": "2022-06-28T16:47:00Z",
      "isPending": false
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "billingEmails": [
    "exampleCorpInvoices@example.com"
  ],
  "taxStatus": "TAXED"
}