Skip to main content
GET
Get customer by 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

OK

id
string
required

Unique ID

Example:

"e309e948-088e-4d77-b654-cd85498f1555"

createdAt
string
required

Created at

Example:

"2022-06-28T16:47:00Z"

Legal name

Example:

"John Doe"

address
object
required

Address

Example:
email
string
required

Main contact email address

Example:

"john@example.com"

integrationIds
object[]
required

External services which are linked to this customer

Example:
billingEmails
string[]
required

Billing email addresses

Example:
taxStatus
enum<string>
required

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

Available options:
TAXED,
TAX_EXEMPT,
REVERSE_CHARGED
Example:

"TAXED"

contactName
string

Contact Name

Example:

"John Doe"

telephone
string

Telephone

Example:

"02010001000"

url
string

URL

Example:

"https://example.com/"

label
string

Label

Example:

"Example customer"

archivedAt
string

Date and time the Customer was archived

Example:

"2022-06-28T16:47:00Z"