Get customer by alias

curl --request GET \
  --url https://eu.sequencehq.com/api/customers/by-alias/{alias} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/customers/by-alias/{alias}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.sequencehq.com/api/customers/by-alias/{alias}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.sequencehq.com/api/customers/by-alias/{alias}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/customers/by-alias/{alias}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "addresses": [
    {
      "purposes": [
        "BILLING"
      ],
      "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"
}

This response has no body data.

This response has no body data.

This response has no body data.

GET

customers

by-alias

{alias}

Get customer by alias

curl --request GET \
  --url https://eu.sequencehq.com/api/customers/by-alias/{alias} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/customers/by-alias/{alias}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.sequencehq.com/api/customers/by-alias/{alias}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.sequencehq.com/api/customers/by-alias/{alias}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/customers/by-alias/{alias}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "addresses": [
    {
      "purposes": [
        "BILLING"
      ],
      "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"
}

This response has no body data.

This response has no body data.

This response has no body data.

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

deprecated

Address

Show child attributes

Example:

{
  "line1": "Flat 1",
  "line2": "123 Fake Street",
  "town": "New York",
  "state": "NY",
  "postcode": "AB1 2EF",
  "country": "US"
}

addresses

object[]

required

The customer's addresses, each with the purposes it serves. At most one address is BILLING and at most one SHIPPING, and one address can be both. Empty when the customer has no addresses. The deprecated address field holds the BILLING address, or a placeholder with an empty line1, town and postcode when there is none.

Show child attributes

Example:

[
  {
    "purposes": ["BILLING"],
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    }
  }
]

string

required

Main contact email address

Example:

"john@example.com"

integrationIds

object[]

required

External services which are linked to this customer

Show child attributes

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 | null

Contact Name

Example:

"John Doe"

telephone

string | null

Telephone

Example:

"02010001000"

url

string | null

URL

Example:

"https://example.com/"

label

string | null

Label

Example:

"Example customer"

archivedAt

string | null

Date and time the Customer was archived

Example:

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

API Reference

Latest Live API

Version 2024-07-30

Get customer by alias

Headers

Path Parameters

Response