Skip to main content
POST
/
v6
/
mileage
/
locations
/
query
Query locations
curl --request POST \
  --url https://sandbox.tight.com/v6/mileage/locations/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "limit": 123,
  "sort": {},
  "filter": {
    "name": {
      "equal": "<string>",
      "notEqual": "<string>",
      "greaterThan": "<string>",
      "greaterThanEqual": "<string>",
      "lessThan": "<string>",
      "lessThanEqual": "<string>",
      "contain": "<string>"
    },
    "status": {
      "in": [],
      "notIn": []
    }
  }
}
'
import requests

url = "https://sandbox.tight.com/v6/mileage/locations/query"

payload = {
"cursor": "<string>",
"limit": 123,
"sort": {},
"filter": {
"name": {
"equal": "<string>",
"notEqual": "<string>",
"greaterThan": "<string>",
"greaterThanEqual": "<string>",
"lessThan": "<string>",
"lessThanEqual": "<string>",
"contain": "<string>"
},
"status": {
"in": [],
"notIn": []
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
limit: 123,
sort: {},
filter: {
name: {
equal: '<string>',
notEqual: '<string>',
greaterThan: '<string>',
greaterThanEqual: '<string>',
lessThan: '<string>',
lessThanEqual: '<string>',
contain: '<string>'
},
status: {in: [], notIn: []}
}
})
};

fetch('https://sandbox.tight.com/v6/mileage/locations/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.tight.com/v6/mileage/locations/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cursor' => '<string>',
'limit' => 123,
'sort' => [

],
'filter' => [
'name' => [
'equal' => '<string>',
'notEqual' => '<string>',
'greaterThan' => '<string>',
'greaterThanEqual' => '<string>',
'lessThan' => '<string>',
'lessThanEqual' => '<string>',
'contain' => '<string>'
],
'status' => [
'in' => [

],
'notIn' => [

]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.tight.com/v6/mileage/locations/query"

payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {},\n \"filter\": {\n \"name\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.tight.com/v6/mileage/locations/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {},\n \"filter\": {\n \"name\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.tight.com/v6/mileage/locations/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {},\n \"filter\": {\n \"name\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "loc_28868401",
      "name": "Home Office",
      "status": "ACTIVE",
      "lat": "38.8977",
      "lng": "-77.0365",
      "address": {
        "countryCode": "USA",
        "state": "<string>",
        "city": "<string>",
        "zip": "<string>",
        "phoneWork": "<string>",
        "address1": "<string>",
        "address2": "<string>"
      },
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ],
  "cursor": {
    "after": "<string>",
    "before": "<string>"
  }
}
{
"result": "FAILURE",
"error": [
{
"type": "REQUIRED",
"message": "Amount is required",
"param": "amount"
}
]
}
{
"result": "FAILURE",
"error": [
{
"type": "INVALID_TOKEN",
"message": "Invalid access token"
}
]
}
{
"result": "FAILURE",
"error": [
{
"type": "FORBIDDEN",
"message": "Expired access token"
}
]
}
{
"result": "FAILURE",
"error": [
{
"type": "BAD_REQUEST",
"message": "Resource not found"
}
]
}
{
"result": "FAILURE",
"error": [
{
"type": "UNKNOWN_ERROR",
"message": "Something went wrong. Please try again later."
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
cursor
string | null

Cursor from the previous paginated response

limit
integer<int32>

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

Required range: x <= 250
sort
object

Sort order for the items in the response.

filter
object

Filter for items in the response.

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
object[]

The data generated by the action performed.

cursor
object

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.