List accounts

Authorizations

Authorization

string

header

required

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

Headers

request-id

string

Optional client generated identifier to trace and debug a request.

correlation-id

string

Optional client generated identifier to trace and debug a series of requests.

Query Parameters

page_number

integer

default:

Results page number. Starts at page 1. Default value: 1

page_size

integer

default:

100

Page size. Default value: 100. Max value: 1000

sort_by

string

default:

Sort By. Default value: 'id'.

sort_order

enum<string>

default:

asc

Sort Order. Default value: 'asc'.

Available options:

asc,

desc

Response

200 - text/plain

data

object[]

required

data.access_level

enum<string>

required

The access level granted to the account. This is determined by your platform configuration. Use standard unless instructed otherwise by Straddle.

Available options:

standard,

managed

data.id

string

required

Unique identifier for the account.

data.organization_id

string

required

The unique identifier of the organization this account belongs to.

data.status

enum<string>

required

The current status of the account (e.g., 'active', 'inactive', 'pending').

Available options:

created,

onboarding,

active,

rejected,

inactive

data.status_detail

object

required

data.type

enum<string>

required

The type of account (e.g., 'individual', 'business').

Available options:

business

data.business_profile

object

data.business_profile.name

string

required

The operating or trade name of the business.

data.business_profile.website

string

required

URL of the business's primary marketing website.

data.business_profile.address

object | null

The address object is optional. If provided, it must be a valid address.

data.business_profile.description

string | null

A brief description of the business and its products or services.

data.business_profile.industry

object

data.business_profile.legal_name

string | null

The official registered name of the business.

data.business_profile.phone

string | null

The primary contact phone number for the business.

data.business_profile.support_channels

object

data.business_profile.tax_id

string | null

The business's tax identification number (e.g., EIN in the US).

data.business_profile.use_case

string | null

A description of how the business intends to use Straddle's services.

data.capabilities

object

data.created_at

string | null

Timestamp of when the account was created.

data.external_id

string | null

Unique identifier for the account in your database, used for cross-referencing between Straddle and your systems.

data.metadata

object | null

Up to 20 additional user-defined key-value pairs. Useful for storing additional information about the account in a structured format.

data.settings

object

data.terms_of_service

object

data.updated_at

string | null

Timestamp of the most recent update to the account.

Fundamentals

Customers

Bridge

Paykeys

Charges

Payouts

Funding

Embed

Authorizations

Headers

Query Parameters

Response