Retrieve addresses

Returns a list of addresses based on search criteria

SecurityShippo_Token
Request
query Parameters
offset
integer (Offset) >= 0
Default: 0
limit
integer (Limit) >= 1
Default: 30
search
string (Search)
Responses
200

Successful Response

422

Unprocessable Entity

5XX

Server Error

get/v2/addresses
Request samples
curl -i -X GET \
'https://api.goshippo.com/v2/addresses?offset=0&limit=30&search=string' \
-H 'Authorization: ShippoToken <API_TOKEN>'
Response samples
application/json
{
  • "offset": 1,
  • "limit": 1,
  • "count": 1,
  • "next": "/addresses?offset=2&limit=1",
  • "prev": "/addresses?offset=0&limit=1",
  • "results": [
    ]
}