Get Locations

Sandbox

https://sandbox.trynavigate.co/api/v1

GET

/locations

Sellers can use this API endpoint to retrieve
all addresses in their address book. Addresses
are returned in pages of a specified size at a
time.

It is also possible to retrieve addresses matching
specific keywords - see the list of API parameters
for details. Search keywords are matched against all
text fields of addresses such as address lines,
city, province/state and country name, and postal
code.

The total number of addresses on the seller's address
book is also returned in the API response. This allows
sellers to determine the total number of pages of
addresses they can retrieve.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Success.

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://sandbox.trynavigate.co/api/v1/locations?search&page&pageSize' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "total": 1,
    "page": 0,
    "pageSize": 1,
    "addresses": [
        {
            "id": 540819,
            "addressType": "SELLER",
            "addressee": "John Smith",
            "companyName": "ACME Inc.",
            "addressLineOne": "1 Madison Square Garden",
            "addressLineTwo": "Turner Street",
            "city": "Toronto",
            "state": "Ontario",
            "country": "Canada",
            "email": "toronto@acme.com",
            "postalCode": "M5V2L4",
            "isdCode": "CA~+1",
            "phone": "9654321087",
            "createdDate": "2024-05-30T00:00:00.000Z",
            "lastUpdatedDate": "2025-06-27T00:00:00.000Z"
        }
    ]
}

Modified at 2025-10-28 04:42:01

Locations API

Add Location