List units
curl --request GET \
--url https://api.example.com/unitsimport requests
url = "https://api.example.com/units"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/units', 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.example.com/units",
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.example.com/units"
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.example.com/units")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/units")
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": [
{
"content_type": "unit",
"id": 1,
"reference": "<string>",
"name": "HQ",
"description": "<string>",
"level": 123,
"path": "<string>",
"unit_type": "unit",
"falldown": true,
"features": [
{}
],
"departments": [
{}
],
"parent": {},
"image": {},
"children": [
{}
],
"addresses": {},
"contact": {},
"opening_hours": {},
"geo": {
"lat": 123,
"lng": 123
},
"stats": {
"users": 123,
"children": 123,
"children_total": 123
},
"permissions": {},
"url": "api/units/1"
}
]
}Units
List units
Returns a paginated list of units. Can be filtered by feature, user membership, and search keyword.
GET
/
units
List units
curl --request GET \
--url https://api.example.com/unitsimport requests
url = "https://api.example.com/units"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/units', 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.example.com/units",
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.example.com/units"
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.example.com/units")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/units")
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": [
{
"content_type": "unit",
"id": 1,
"reference": "<string>",
"name": "HQ",
"description": "<string>",
"level": 123,
"path": "<string>",
"unit_type": "unit",
"falldown": true,
"features": [
{}
],
"departments": [
{}
],
"parent": {},
"image": {},
"children": [
{}
],
"addresses": {},
"contact": {},
"opening_hours": {},
"geo": {
"lat": 123,
"lng": 123
},
"stats": {
"users": 123,
"children": 123,
"children_total": 123
},
"permissions": {},
"url": "api/units/1"
}
]
}Query Parameters
Filter by feature ID
Limit results to units related to the current user
Search keyword applied to unit name
Include extended statistics for each unit
Pagination size
Pagination page number
Response
200 - application/json
A paginated list of units.
Show child attributes
Show child attributes
⌘I