Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

agentId
required

Agent identifier to list addresses for

Pattern: ^[0-9a-z]+$
type
enum<string>

Filter addresses by type

Available options:
BILLING,
SHIPPING,
MAILING,
REGISTERED

Response

200 - application/json

OK

id
string
required

Unique address identity identifier

agentId
string
required

Agent that owns this address

orgId
string
required

Organization the address belongs to

type
enum<string>
required

Address type

Available options:
BILLING,
SHIPPING,
MAILING,
REGISTERED
label
string | null
required

User-defined label

street1
string
required

Primary street address line

street2
string | null
required

Secondary street address line

city
string
required

City name

state
string
required

State or province

postalCode
string
required

Postal or ZIP code

country
string
required

2-character ISO country code

validated
boolean
required

Whether the address has been validated

validatedAt
string<date-time> | null
required

Timestamp when the address was validated

provider
string | null
required

Validation provider name

metadata
object | null
required

Additional metadata

isPrimary
boolean
required

Whether this is the primary address for its type

createdAt
string<date-time>
required

Timestamp when the address was created

updatedAt
string<date-time>
required

Timestamp when the address was last updated