v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Mileage Locations

Query locations

Query favorite locations for the authenticated user

post/v6/mileage/locations/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "loc_28868401",
      "name": "Home Office",
      "status": "ACTIVE",
      "lat": "38.8977",
      "lng": "-77.0365",
      "address": {
        "countryCode": "USA"
      },
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}