List Locations
curl --request GET \
--url https://console.lomaplatform.com/api/org/v1/locations \
--header 'API-Key: <api-key>'import requests
url = "https://console.lomaplatform.com/api/org/v1/locations"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://console.lomaplatform.com/api/org/v1/locations', 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://console.lomaplatform.com/api/org/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.lomaplatform.com/api/org/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.lomaplatform.com/api/org/v1/locations")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.lomaplatform.com/api/org/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "OBG47x1f4pGq",
"external_id": "LOC_1",
"name": "Test Location 1",
"address_line_1": "123 Smith Road",
"address_line_2": null,
"address_city": "Atlanta",
"address_state": "Georgia",
"address_zip": "12345",
"date_opened": "2023-11-28",
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
},
{
"id": "uPY8HK8As3Kg",
"external_id": null,
"name": "Test Location 2",
"address_line_1": "456 Apple Road",
"address_line_2": "",
"address_city": "Chicago",
"address_state": "IL",
"address_zip": "12345",
"date_opened": null,
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
}
]{
"error": {
"issues": [
"<unknown>"
],
"name": "<string>"
}
}{
"error": {
"status": 401,
"message": "Invalid API Key"
}
}Locations
List Locations
Lists locations for an organization
GET
/
api
/
org
/
v1
/
locations
List Locations
curl --request GET \
--url https://console.lomaplatform.com/api/org/v1/locations \
--header 'API-Key: <api-key>'import requests
url = "https://console.lomaplatform.com/api/org/v1/locations"
headers = {"API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Key': '<api-key>'}};
fetch('https://console.lomaplatform.com/api/org/v1/locations', 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://console.lomaplatform.com/api/org/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://console.lomaplatform.com/api/org/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://console.lomaplatform.com/api/org/v1/locations")
.header("API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.lomaplatform.com/api/org/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "OBG47x1f4pGq",
"external_id": "LOC_1",
"name": "Test Location 1",
"address_line_1": "123 Smith Road",
"address_line_2": null,
"address_city": "Atlanta",
"address_state": "Georgia",
"address_zip": "12345",
"date_opened": "2023-11-28",
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
},
{
"id": "uPY8HK8As3Kg",
"external_id": null,
"name": "Test Location 2",
"address_line_1": "456 Apple Road",
"address_line_2": "",
"address_city": "Chicago",
"address_state": "IL",
"address_zip": "12345",
"date_opened": null,
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
}
]{
"error": {
"issues": [
"<unknown>"
],
"name": "<string>"
}
}{
"error": {
"status": 401,
"message": "Invalid API Key"
}
}Authorizations
API Key for the organization
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 1000Available options:
name, created_at, updated_at Available options:
asc, desc Response
200 OK
Example:
[
{
"id": "OBG47x1f4pGq",
"external_id": "LOC_1",
"name": "Test Location 1",
"address_line_1": "123 Smith Road",
"address_line_2": null,
"address_city": "Atlanta",
"address_state": "Georgia",
"address_zip": "12345",
"date_opened": "2023-11-28",
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
},
{
"id": "uPY8HK8As3Kg",
"external_id": null,
"name": "Test Location 2",
"address_line_1": "456 Apple Road",
"address_line_2": "",
"address_city": "Chicago",
"address_state": "IL",
"address_zip": "12345",
"date_opened": null,
"created_at": "2023-11-28 16:10:38.65394+00",
"updated_at": "2024-05-29 16:02:08.543+00"
}
]
⌘I