List Accounts

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at"

filter

object | null

Filter parameters that allow greater customisation of the list response

Show child attributes

filter.updated_after

string | null

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

next

string | null

The unified cursor

updated_after

string | null

deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

Response

200

application/json

The list of accounts was retrieved.

data

object[]

required

Show child attributes

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.owner_id

string | null

data.remote_owner_id

string | null

Provider's unique identifier of the owner

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.name

string | null

data.description

string | null

data.industries

string[] | null

Values of the industries

Example:

[
  "Information Technology",
  "Airlines & Airports",
  "Personal Care & Household Products"
]

data.annual_revenue

string | null

data.website

string | null

data.addresses

object[] | null

Show child attributes

data.addresses.street_1

string | null

data.addresses.street_2

string | null

data.addresses.city

string | null

data.addresses.state

string | null

data.addresses.zip_code

string | null

data.addresses.country

object

The country code

Show child attributes

data.addresses.country.value

enum<string> | null

The ISO 3166-1 alpha-2 code of the country.

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

Example:

"GB"

data.addresses.country.source_value

The source value of the ISO 3166-1 alpha-2 code of the country.

Example:

"GB"

data.addresses.location_type

object

The location type

Show child attributes

data.addresses.location_type.value

enum<string> | null

The type of the location.

Available options:

home,

work,

unmapped_value

Example:

"home"

data.addresses.location_type.source_value

The source value of the location type.

Example:

"Home"

data.phone_numbers

string[] | null

List of account phone numbers

Example:

["[phone]"]

data.created_at

string | null

Timestamp when the account was created

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

Timestamp when the account was last updated

Example:

"2021-01-01T01:01:01.000Z"

next_page

string | null

deprecated

next

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

string | null

raw.response

object | null