Skip to main content
GET
/
units
/
{unit}
Get unit by ID
curl --request GET \
  --url https://api.example.com/units/{unit}
import requests

url = "https://api.example.com/units/{unit}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/units/{unit}', 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/{unit}",
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/{unit}"

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/{unit}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/units/{unit}")

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
{
  "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"
}

Path Parameters

unit
string
required

Unit identifier (ID or reference depending on route)

Response

Unit details

content_type
string
Example:

"unit"

id
integer
Example:

1

reference
string | null
name
string
Example:

"HQ"

description
string | null
level
integer

Depth in unit tree

path
string

Materialized path

unit_type
string
Example:

"unit"

falldown
boolean | null

From pivot when in context

features
object[] | null
departments
object[] | null
parent
object | null

Parent unit when loaded

image
object | null

Unit image when loaded

children
object[] | null
addresses
object

Company, delivery, invoicing addresses

contact
object

Contact name and phone

opening_hours
object

Office hours and closed days

geo
object
stats
object | null
permissions
object

Permission flags for current user

url
string
Example:

"api/units/1"