Skip to main content
GET
List accounts

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Query Parameters

account_type
enum<string>

Filter by account type. 'customer' is a synthetic alias for business/individual/lead.

Available options:
business,
individual,
lead,
vendor,
all

Full-text search via accounts.searchable_text.

is_active
enum<string>

Filter by active status. Default returns all.

Available options:
true,
false,
all
include_inactive
boolean

Legacy alias for is_active=all.

page
integer
default:1
per_page
integer
default:25
Required range: x <= 100
expand[]
enum<string>[]
Available options:
data.addresses,
data.contacts,
data.payment_methods,
data.default_payment_method,
data.recent_orders,
data.credit_terms

Response

Paginated account list

data
object[]
total
integer
page
integer
per_page
integer
total_pages
integer