List Locations
curl --request GET \
--url https://api.wellapp.ai/v1/locationsimport requests
url = "https://api.wellapp.ai/v1/locations"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.wellapp.ai/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://api.wellapp.ai/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.wellapp.ai/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wellapp.ai/v1/locations")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "location",
"id": "uuid",
"attributes": {}
}
],
"meta": {
"total": 0,
"count": 0
},
"links": {
"next": null
}
}Location
Get Location
Workspace-scoped, cursor-paginated list of location records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
GET
/
v1
/
locations
List Locations
curl --request GET \
--url https://api.wellapp.ai/v1/locationsimport requests
url = "https://api.wellapp.ai/v1/locations"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.wellapp.ai/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://api.wellapp.ai/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://api.wellapp.ai/v1/locations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wellapp.ai/v1/locations")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wellapp.ai/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"type": "location",
"id": "uuid",
"attributes": {}
}
],
"meta": {
"total": 0,
"count": 0
},
"links": {
"next": null
}
}Complex Usage Example
Advanced Location Filtering with Full Context
This example demonstrates advanced filtering with multiple parameters, relationship inclusion, status filtering, and sorting for retrieving locations:curl -X GET "https://api.well.com/v1/locations?include=persons,companies,workspaces&workspace_id=550e8400-e29b-41d4-a716-446655440000&company_id=550e8400-e29b-41d4-a716-446655440001&is_registered=true&is_primary=true&created_at_from=2023-01-01T00:00:00Z&created_at_to=2023-12-31T23:59:59Z&updated_at_from=2023-06-01T00:00:00Z&sort=-created_at&page[limit]=20&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyMy0xMS0wMlQxMDozMDowMFoiLCJpZCI6ImxvY2F0aW9uOS11dWlkIn0=" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Query Parameters
Page size (max 200).
Required range:
x <= 200Opaque keyset cursor; omit for the first page.
Field to order by.
Available options:
asc, desc Optional explicit workspace scope (Firebase-authenticated callers).
Response
A page of location records.