List your accounts

GET

sequence-accounts

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

Copy
{
  "items": [
    {
      "id": "7e330949-a175-496a-a060-27821656ce34",
      "createdAt": "2022-06-28T16:47:00Z",
      "sequenceOrganisationId": "13448448-ce43-4874-8acf-8ff2a8ca24c1",
      "companyName": "Acme Inc.",
      "companyNumber": "GB123987",
      "country": "GB",
      "sendCustomerNotifications": true,
      "alertEmailAddresses": [
        "alerts@example.com"
      ]
    }
  ],
  "pagination": {
    "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
    "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
    "totalResultSize": 100
  }
}

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

limit

integer

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

after

string

Pagination offset. 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.

before

string

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

Response

200

application/json

items

object[]

required

A list of Sequence accounts that you have access to.

items.id

string

required

Unique identifier for the Sequence account.

Example:

"b6b0bb79-7b03-4cc0-9c70-2d3aec3aeb17"

items.createdAt

string

required

The time at which the account was created. Formatted as an ISO 8601 timestamp.

Example:

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

items.sequenceOrganisationId

string

required

The Sequence organisation ID that this account belongs to.

Example:

"e4f49f12-38cf-4fcf-ad2a-0ae7d83d6be4"

items.companyName

string

required

The company name of the company that owns this Sequence account.

Example:

"Acme Inc."

items.companyNumber

string

required

The company number of the company that owns this Sequence account.

Example:

"GB123988"

items.country

enum<string>

required

The country in which the company who owns this account is registered.

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:

"GB"

items.sendCustomerNotifications

boolean

required

True if Sequence should send customer notifications on your behalf.

Example:

true

items.alertEmailAddresses

string[]

required

List of email addresses to which alert notifications will be sent.

Example:

["alerts@example.com"]

Example:

[
  {
    "id": "7e330949-a175-496a-a060-27821656ce34",
    "createdAt": "2022-06-28T16:47:00Z",
    "sequenceOrganisationId": "13448448-ce43-4874-8acf-8ff2a8ca24c1",
    "companyName": "Acme Inc.",
    "companyNumber": "GB123987",
    "country": "GB",
    "sendCustomerNotifications": true,
    "alertEmailAddresses": ["alerts@example.com"]
  }
]

pagination

object

required

Results pagination

Example:

{
  "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
  "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
  "totalResultSize": 100
}

Update Account List all Users

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

Copy
{
  "items": [
    {
      "id": "7e330949-a175-496a-a060-27821656ce34",
      "createdAt": "2022-06-28T16:47:00Z",
      "sequenceOrganisationId": "13448448-ce43-4874-8acf-8ff2a8ca24c1",
      "companyName": "Acme Inc.",
      "companyNumber": "GB123987",
      "country": "GB",
      "sendCustomerNotifications": true,
      "alertEmailAddresses": [
        "alerts@example.com"
      ]
    }
  ],
  "pagination": {
    "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
    "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
    "totalResultSize": 100
  }
}

API Reference

Latest Live API

Version 2024-07-30

List your accounts

Headers

Query Parameters

Response