List addresses
Returns a paginated list of addresses for the organization, optionally filtered by type.
Authorizations
JWT access token or API token (prefixed with zipp_)
Path Parameters
Organization ID
"org_01HZX9K2QF"
Query Parameters
Page number (1-based)
1 <= x <= 90071992547409911
Items per page (max 100)
1 <= x <= 10020
Filter by address type (sender, pickup, return)
sender, pickup, return "sender"
Filter by ISO 3166-1 alpha-2 country code.
2"DK"
Search by address name, contact or city.
"Copenhagen"
Filter by brand. Pass a brand ID, or "none" for records not assigned to any brand.
"brnd_8f3kd92ld0"
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.
own, shared, both "own"