Skip to main content
GET
/
v2
/
addresses
curl
curl -i -X GET \
'https://api.goshippo.com/v2/addresses?offset=0&limit=30&search=string' \
-H 'Authorization: ShippoToken <API_TOKEN>'
{
  "count": 1,
  "results": [
    {
      "id": "e9f1f6fd20f84982afe471ff06c5a80f",
      "address": {
        "name": "Wilson",
        "address_line_1": "731 Market Street",
        "country_code": "US",
        "email": "user@shippo.com",
        "phone": "+1-4155550132",
        "organization": "Shippo",
        "address_line_2": "#200",
        "city_locality": "San Francisco",
        "state_province": "CA",
        "postal_code": "94103",
        "address_type": "residential"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "offset": 1,
  "limit": 1,
  "next": "/addresses?offset=2&limit=1",
  "prev": "/addresses?offset=0&limit=1"
}

Authorizations

​
Authorization
string
header
default:ShippoToken
required

Enter your shippo token with the ShippoToken prefix.

Example: ShippoToken shippo_live_xxxx

Query Parameters

​
offset
integer
default:0
Required range: x >= 0
​
limit
integer
default:30
Required range: x >= 1
​
search
string

Response

Successful Response

​
count
integer
required
Example:

1

​
results
AddressWithMetadata · object[]
required
​
offset
integer | null
Example:

1

​
limit
integer | null
Example:

1

​
next
string | null
Example:

"/addresses?offset=2&limit=1"

​
prev
string | null
Example:

"/addresses?offset=0&limit=1"