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": "[email protected]",
  "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": [
    "[email protected]"
  ],
  "taxStatus": "TAXED"
}

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": "[email protected]",
  "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": [
    "[email protected]"
  ],
  "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

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

Show child attributes

address.line1

string

required

Address line 1

Example:

"7500 Bluewater Rd NW"

address.town

string

required

Town or city

Example:

"Albuquerque"

address.postcode

string

required

Postal code

Example:

"87121"

address.country

enum<string>

required

Country code (ISO 3166-1 alpha-2)

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XK,

YE,

YT,

ZA,

ZM,

ZW

Example:

"US"

address.state

enum<string>

State (required for USA only)

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DC,

DE,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AB,

BC,

MB,

NB,

NL,

NS,

NT,

NU,

ON,

PE,

QC,

SK,

YT

Example:

"NY"

Example:

{
  "line1": "7500 Bluewater Rd NW",
  "town": "Albuquerque",
  "state": "NY",
  "postcode": "87121",
  "country": "US"
}

string

required

Main contact email address

Example:

"[email protected]"

integrationIds

object[]

required

External services which are linked to this customer

Show child attributes

integrationIds.service

enum<string>

required

Available options:

Amazon_Redshift,

GoCardless,

Google_BigQuery,

Google_Sheets,

HubSpot,

NetSuite,

QuickBooks_Online,

Salesforce,

Slack,

Snowflake,

Stripe,

Xero,

Avalara,

Anrok,

Attio,

Numeral,

Rillet

Example:

"Xero"

integrationIds.id

string

required

Example:

"2aaff66f-ef30-4599-b192-c168fd4cd226"

integrationIds.isPending

boolean

required

Example:

false

integrationIds.lastSynced

string

Example:

"2024-03-28T16:47:00Z"

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:

["[email protected]"]

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"

Create a new Customer Alias

List all contacts for a customer

⌘I

API Reference

Latest Live API

Version 2024-07-30

Get customer by alias

Headers

Path Parameters

Response