List customers

GET

customers

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

Copy
{
  "items": [
    {
      "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"
      },
      "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
        }
      ],
      "taxStatus": "TAXED"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

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

Query Parameters

sortBy

string

Sort column. Default: creation time.

legalName

string

Filter by legal name

string

Filter by email

alias

string

Filter by alias

includeArchived

boolean

Include archived customers

before

string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

after

string

limit

integer

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

sortOrder

string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

Response

200

application/json

items

object[]

required

Customers

items.id

string

required

Unique ID

Example:

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

items.createdAt

string

required

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

Example:

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

items.organizations

object[]

required

Organizations that this customer is a member of

items.organizations.id

string

required

Organization ID

Example:

"c0dc4e79-ec52-4811-8cf5-addb2527915c"

items.organizations.owner

object

required

ID of the customer that will own the organization.

Example:

{
  "id": "50af5191-05a3-42a5-802a-6b59091157af",
  "name": "FinTech Solutions Inc."
}

items.organizations.members

object[]

required

Members of the customer organization, excluding the owner. These are the children in a parent-child relationship.

ID of the customer that will own the organization.

Example:

[
  {
    "id": "e309e948-088e-4d77-b654-cd85498f1555",
    "name": "Fintech Payment Processing"
  },
  {
    "id": "50af5191-05a3-42a5-802a-6b59091157af",
    "name": "Fintech Lending Services"
  }
]

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"
      }
    ]
  }
]

items.legalName

string

required

Legal name

Example:

"Fintech Payment Processing"

items.address

object

required

Address

Example:

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

items.integrationIds

object[]

required

External services which are linked to this customer

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
  }
]

items.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"

items.url

string

URL

Example:

"https://example.com/"

items.domain

string

Customer's primary domain name

Example:

"example.com"

items.label

string

Label

Example:

"Example customer"

Example:

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

pagination

object

required

Results pagination

Example:

{
  "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
  "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
  "totalResultSize": 10
}

Archive customer Create customer

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

Copy
{
  "items": [
    {
      "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"
      },
      "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
        }
      ],
      "taxStatus": "TAXED"
    }
  ],
  "pagination": {
    "after": "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3",
    "before": "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz",
    "totalResultSize": 10
  }
}

API Reference

Latest Live API

Version 2024-07-30

Headers

Query Parameters

Response