Skip to main content
GET
List addresses

Authorizations

Authorization
string
header
required

A bearer token obtained through one of the two flows below.

Query Parameters

filter[kind]
enum<string>
Available options:
shipping,
billing
page[number]
integer
default:1
Required range: x >= 1
page[size]
integer
default:25
Required range: 1 <= x <= 50

Response

The addresses on this account.

data
object[]
required
included
object[]

Present when the answer is a page.

meta
object

page when the answer is a page: from, to, perPage and hasMore for a cursor (from and to are cursors, not numbers), or currentPage, from, lastPage, perPage, to and total for numbered pages. Some lists add their own beside it, such as statusCounts, unread or facets.