Skip to main content
GET
/
workspaces
/
{workspaceId}
/
organizations
/
{organizationId}
/
children
List child organizations
curl --request GET \
  --url https://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children', 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://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://v1.api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId}/children")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "org_aBcDeFg123456789",
      "name": "Engineering Department",
      "workspace_id": "ws_a1b2c3d4e5f6g7h8",
      "external_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "parent_org_id": "org_zYxWvUt987654321",
      "path": "org_root123#org_parent456",
      "depth": 2,
      "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
      "picture": "https://cdn.altostrat.io/logos/engineering.png",
      "usage": {
        "usage": {
          "locations": 2,
          "users": 5
        },
        "subtree_usage": {
          "locations": 10,
          "users": 25
        }
      },
      "limits": {
        "locations": 10,
        "users": 50
      },
      "branding": {
        "display_name": "ACME Corp",
        "login_hint": "acme-corp",
        "colors": {
          "primary": "#FF5733",
          "page_background": "#FFFFFF"
        }
      }
    }
  ],
  "has_more": false
}

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer {token}

Path Parameters

workspaceId
string
required

The ID of the workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

organizationId
string
required

The ID of the organization.

Example:

"org_aBcDeFg123456789"

Response

A list of child organization objects.

data
object[]
has_more
boolean
Example:

false