Skip to main content
GET
List account addresses across accounts in this entity

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_id
string<uuid>

Filter to addresses belonging to this account.

external_source
string

Filter by provenance source label (e.g. versa_cloud, bubble, shopify). Migration back-read pattern.

external_id
string

Filter by the source system's row identifier. Often combined with external_source for an exact-tuple lookup.

limit
integer
default:25

Number of rows to return. Default 25, max 500.

Required range: 1 <= x <= 500
starting_after
string<uuid>

Cursor: an address id from a previous response. Returns rows ordered before this cursor by (created_at DESC, id DESC).

Response

List of account addresses

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
next_cursor
string<uuid> | null
url
string
Example:

"/v1/account-addresses"