Skip to main content
GET
/
v1
/
website
/
{team}
/
agents
/
carrier
/
{carrier}
/
country
/
{country}
/
area
/
latitude
/
min
/
{minLatitude}
/
max
/
{maxLatitude}
/
longitude
/
min
/
{minLongitude}
/
max
/
{maxLongitude}
List agents within a geospatial area.
curl --request GET \
  --url https://app.smartsend.io/api/v1/website/{team}/agents/carrier/{carrier}/country/{country}/area/latitude/min/{minLatitude}/max/{maxLatitude}/longitude/min/{minLongitude}/max/{maxLongitude} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "c5540f2b-3eea-45c4-957a-9d7b53f899e7",
      "type": "agent",
      "agent_no": "2134",
      "carrier": "postnord",
      "distance": 1.22,
      "company": "Kiosk 88",
      "name_line1": "John",
      "name_line2": "Doe",
      "address_line1": "Nordre Frihavnsgade",
      "address_line2": "88",
      "postal_code": "2100",
      "city": "Copenhagen",
      "country": "DK",
      "coordinates": {
        "latitude": 55.702632904052734,
        "longitude": 12.58386516571045
      },
      "opening_hours": [
        {
          "day": "monday",
          "opens": "07:30:00",
          "closes": "17:30:00"
        }
      ]
    }
  ],
  "meta": {
    "current_page": "1",
    "from": "1",
    "path": "https://example.com/api/example",
    "per_page": "15",
    "to": "15",
    "last_page": "10",
    "total": "140"
  }
}

Authorizations

Authorization
string
header
required

Provide API Token as Bearer authentication

api_token
string
query
required

Query API Token

Path Parameters

team
string
required

The domain of the website making the agent lookup request

carrier
enum<string>
required

The carrier code

Available options:
postnord,
gls,
dao,
bifrost,
bring
country
string
required

ISO3166 Alpha2 country code

Required string length: 2
minLatitude
number
required

The minimum latitude of the geospatial area

maxLatitude
number
required

The maximum latitude of the geospatial area

minLongitude
number
required

The minimum longitude of the geospatial area

maxLongitude
number
required

The maximum longitude of the geospatial area

Response

Successful operation

data
object[]

Data container

meta
object

Legth Aware Pagination Resource Pagination resource

I