Get customer

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

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

fetch('https://eu.sequencehq.com/api/customers/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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": "2021-01-02T10:55:00Z",
  "organizations": [
    {
      "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
      "owner": {
        "id": "50af5191-05a3-42a5-802a-6b59091157af",
        "name": "FinTech Solutions Inc."
      },
      "members": [
        {
          "id": "e309e948-088e-4d77-b654-cd85498f1555",
          "name": "Fintech Payment Processing"
        },
        {
          "id": "50af5191-05a3-42a5-802a-6b59091157af",
          "name": "Fintech Lending Services"
        }
      ]
    }
  ],
  "legalName": "Fintech Payment Processing",
  "address": {
    "line1": "7500 Bluewater Rd NW",
    "town": "Albuquerque",
    "state": "NY",
    "postcode": "87121",
    "country": "US"
  },
  "addresses": [
    {
      "purposes": [
        "BILLING"
      ],
      "address": {
        "line1": "7500 Bluewater Rd NW",
        "town": "Albuquerque",
        "state": "NY",
        "postcode": "87121",
        "country": "US"
      }
    },
    {
      "purposes": [
        "SHIPPING"
      ],
      "address": {
        "line1": "Flat 1",
        "line2": "123 Fake Street",
        "town": "New York",
        "state": "NY",
        "postcode": "AB1 2EF",
        "country": "US"
      }
    }
  ],
  "url": "https://example.com/",
  "domain": "example.com",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    }
  ],
  "archivedAt": "2025-08-28T12:00:00Z",
  "taxStatus": "TAXED",
  "contacts": [
    {
      "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "John Smith",
      "email": "john.smith@example.com",
      "billingPreference": "NONE",
      "purposes": [],
      "notificationSubscriptions": [],
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "archivedAt": "2023-06-28T16:47:00Z"
    }
  ],
  "status": "ACTIVE",
  "customProperties": {
    "region": "EU",
    "tier": "gold"
  }
}

This response has no body data.

This response has no body data.

This response has no body data.

GET

customers

{id}

Get customer

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

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

fetch('https://eu.sequencehq.com/api/customers/{id}', 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/{id}",
  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/{id}"

	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/{id}")

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": "2021-01-02T10:55:00Z",
  "organizations": [
    {
      "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
      "owner": {
        "id": "50af5191-05a3-42a5-802a-6b59091157af",
        "name": "FinTech Solutions Inc."
      },
      "members": [
        {
          "id": "e309e948-088e-4d77-b654-cd85498f1555",
          "name": "Fintech Payment Processing"
        },
        {
          "id": "50af5191-05a3-42a5-802a-6b59091157af",
          "name": "Fintech Lending Services"
        }
      ]
    }
  ],
  "legalName": "Fintech Payment Processing",
  "address": {
    "line1": "7500 Bluewater Rd NW",
    "town": "Albuquerque",
    "state": "NY",
    "postcode": "87121",
    "country": "US"
  },
  "addresses": [
    {
      "purposes": [
        "BILLING"
      ],
      "address": {
        "line1": "7500 Bluewater Rd NW",
        "town": "Albuquerque",
        "state": "NY",
        "postcode": "87121",
        "country": "US"
      }
    },
    {
      "purposes": [
        "SHIPPING"
      ],
      "address": {
        "line1": "Flat 1",
        "line2": "123 Fake Street",
        "town": "New York",
        "state": "NY",
        "postcode": "AB1 2EF",
        "country": "US"
      }
    }
  ],
  "url": "https://example.com/",
  "domain": "example.com",
  "label": "Example customer",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    },
    {
      "service": "Stripe",
      "id": "cus_OCtCxqQDgu1uX9",
      "lastSynced": "2024-03-28T16:47:00Z",
      "isPending": false
    }
  ],
  "archivedAt": "2025-08-28T12:00:00Z",
  "taxStatus": "TAXED",
  "contacts": [
    {
      "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
      "name": "John Smith",
      "email": "john.smith@example.com",
      "billingPreference": "NONE",
      "purposes": [],
      "notificationSubscriptions": [],
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "archivedAt": "2023-06-28T16:47:00Z"
    }
  ],
  "status": "ACTIVE",
  "customProperties": {
    "region": "EU",
    "tier": "gold"
  }
}

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

string

required

Customer ID

Response

string

required

Unique ID

Example:

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

createdAt

string

required

Time at which the customer was initially created, in ISO 8601 format

Example:

"2021-01-02T10:55:00Z"

organizations

object[]

required

Organizations that this customer is a member of

Show child attributes

Example:

[
  {
    "id": "c0dc4e79-ec52-4811-8cf5-addb2527915c",
    "owner": {
      "id": "50af5191-05a3-42a5-802a-6b59091157af",
      "name": "FinTech Solutions Inc."
    },
    "members": [
      {
        "id": "e309e948-088e-4d77-b654-cd85498f1555",
        "name": "Fintech Payment Processing"
      },
      {
        "id": "50af5191-05a3-42a5-802a-6b59091157af",
        "name": "Fintech Lending Services"
      }
    ]
  }
]

legalName

string

required

Legal name

Example:

"Fintech Payment Processing"

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": "7500 Bluewater Rd NW",
      "town": "Albuquerque",
      "state": "NY",
      "postcode": "87121",
      "country": "US"
    }
  },
  {
    "purposes": ["SHIPPING"],
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    }
  }
]

integrationIds

object[]

required

External services which are linked to this customer

Show child attributes

Example:

[
  {
    "service": "Xero",
    "id": "2aaff66f-ef30-4599-b192-c168fd4cd226",
    "lastSynced": "2024-03-28T16:47:00Z",
    "isPending": false
  },
  {
    "service": "Stripe",
    "id": "cus_OCtCxqQDgu1uX9",
    "lastSynced": "2024-03-28T16:47:00Z",
    "isPending": false
  }
]

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"

contacts

object[]

required

Contacts for this customer

Show child attributes

Example:

[
  {
    "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
    "name": "John Smith",
    "email": "john.smith@example.com",
    "billingPreference": "NONE",
    "purposes": [],
    "notificationSubscriptions": [],
    "createdAt": "2022-06-28T16:47:00Z",
    "updatedAt": "2022-06-28T16:47:00Z",
    "archivedAt": "2023-06-28T16:47:00Z"
  }
]

status

enum<string>

required

Customer status:

DRAFT means the customer has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a customer is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

customProperties

object

required

Custom key-value properties for this customer

Show child attributes

Example:

{ "region": "EU", "tier": "gold" }

url

string | null

URL

Example:

"https://example.com/"

domain

string | null

Customer's primary domain name

Example:

"example.com"

label

string | null

Label

Example:

"Example customer"

archivedAt

string | null

Time at which the customer was archived, in ISO 8601 format

Example:

"2025-08-28T12:00:00Z"

API Reference

Latest Live API

Version 2024-07-30

Get customer

Headers

Path Parameters

Response