Skip to main content
GET
/
customers
/
by-alias
/
{alias}
Get customer by alias
curl --request GET \
  --url https://dev.seqhq.io/api/customers/by-alias/{alias} \
  --header 'Authorization: <authorization>'
{
  "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"
}

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"

​
legalName
string
required

Legal name

Example:

"John Doe"

​
address
object
required

Address

Example:
{
  "line1": "7500 Bluewater Rd NW",
  "town": "Albuquerque",
  "state": "NY",
  "postcode": "87121",
  "country": "US"
}
​
email
string
required

Main contact email address

Example:

"john@example.com"

​
integrationIds
object[]
required

External services which are linked to this customer

Example:
[
  {
    "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
  }
]
​
billingEmails
string[]
required

Billing email addresses

Example:
["exampleCorpInvoices@example.com"]
​
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"