GET
/
customers
/
by-alias
/
{alias}

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

alias
string
required

Customer alias

Response

200 - application/json
id
string
required

Unique ID

createdAt
string
required

Created at

legalName
string
required

Legal name

address
object
required

Address

email
string
required

Main contact email address

integrationIds
object[]
required

External services which are linked to this customer

billingEmails
string[]
required

Billing email addresses

taxStatus
enum<string>
required

Tax status applicable to customer. Can be one of TAXED, EXEMPT or REVERSE_CHARGED. The default is TAXED.

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
contactName
string

Contact Name

telephone
string

Telephone

url
string

URL

label
string

Label

archivedAt
string

Date and time the Customer was archived

Create a new Customer AliasList all contacts for a customer