Skip to main content
GET
/
api
/
rest
/
addresses
Get Many Addresses
curl --request GET \
  --url https://api.upwell.com/api/rest/addresses
{
  "addresses": [
    {
      "city": "<string>",
      "companyName": "<string>",
      "country": "AD",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "phoneNumber": "<string>",
      "stateOrProvince": "<string>",
      "streetLine1": "<string>",
      "streetLine2": "<string>",
      "streetLine3": "<string>",
      "type": "ADDRESS_BOOK",
      "updatedAt": "2023-11-07T05:31:56Z",
      "zipOrPostalCode": "<string>"
    }
  ]
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

limit
integer
default:10
offset
integer
default:0

Response

200 - application/json

Responses for GET /api/rest/addresses

addresses
Addresses Ā· object[]