Shipping::Address

List shipping addresses

Changed on

listShippingAddresses

get/contacts/{contact_id}/shipping/addresses

Request

Path parameters

contact_idstring required

Contact ID

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger
public_idstring

Shipping entry public ID

contact_idinteger
first_namestring nullable

First name

last_namestring nullable

Last name

organization_namestring nullable

Organization name

phone_numberstring nullable

Phone number

defaultboolean

Whether the contact's default shipping pointer selects this entry

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": 501,
    "public_id": "kDgPqW",
    "contact_id": 123,
    "first_name": "Jane",
    "last_name": "Doe",
    "organization_name": "Acme Inc",
    "phone_number": "+18005550199",
    "default": true,
    "address": {
      "id": 9001,
      "public_id": "aXbYcZ",
      "address_one": "3443 W. Bavaria St.",
      "address_two": "Suite 100",
      "city": "Eagle",
      "region": "ID",
      "region_name": "Idaho",
      "country": "US",
      "postal_code": "83616",
      "created_at": "2026-10-01T10:00:00Z",
      "updated_at": "2026-10-01T10:00:00Z"
    },
    "created_at": "2026-10-01T10:00:00Z",
    "updated_at": "2026-10-01T10:00:00Z"
  }
]

Changes