Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

JWT access token or API token (prefixed with zipp_)

Path Parameters

orgId
string
required

Organization ID

Example:

"org_01HZX9K2QF"

Query Parameters

page
integer
default:1

Page number (1-based)

Required range: 1 <= x <= 9007199254740991
Example:

1

limit
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100
Example:

20

type
enum<string>

Filter by address type (sender, pickup, return)

Available options:
sender,
pickup,
return
Example:

"sender"

countryCode
string

Filter by ISO 3166-1 alpha-2 country code.

Required string length: 2
Example:

"DK"

Search by address name, contact or city.

Example:

"Copenhagen"

brandId
string

Filter by brand. Pass a brand ID, or "none" for records not assigned to any brand.

Example:

"brnd_8f3kd92ld0"

brandScope
enum<string>

How the brand context narrows this list: "own" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), "shared" returns only unassigned organization-wide rows, "both" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with "shared" returns no rows, since those records are never visible organization-wide from within a brand context.

Available options:
own,
shared,
both
Example:

"own"

Response

Default Response

data
object[]
required

Page of results

total
number
required

Total matching items across all pages

Example:

137

page
number
required

Current page number (1-based)

Example:

1

limit
number
required

Items per page

Example:

20

totalPages
number
required

Total number of pages

Example:

7