List organizations

curl --request GET \
  --url https://api.altostrat.io/workspaces/{workspaceId}/organizations \
  --header 'Authorization: Bearer <token>'

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

GET

workspaces

{workspaceId}

organizations

List organizations

curl --request GET \
  --url https://api.altostrat.io/workspaces/{workspaceId}/organizations \
  --header 'Authorization: Bearer <token>'

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

Response

A list of organization objects.

data

object[]

Show child attributes

data.id

string

Unique identifier for the organization (corresponds to Auth0 organization ID), prefixed with org_.

Example:

"org_aBcDeFg123456789"

data.name

string

The human-readable name of the organization.

Example:

"Engineering Department"

data.workspace_id

string

The ID of the workspace this organization belongs to.

Example:

"ws_a1b2c3d4e5f6g7h8"

data.external_id

string<uuid>

A stable, unique identifier for the organization, independent of its Auth0 ID.

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

data.parent_org_id

string | null

The ID of the parent organization, if this is a child organization.

Example:

"org_zYxWvUt987654321"

data.path

string | null

A #-separated string representing the hierarchical path of ancestors.

Example:

"org_root123#org_parent456"

data.depth

integer

The depth of the organization in the hierarchy (0 for top-level).

Example:

2

data.billing_account_id

string | null

The ID of the billing account this organization is associated with (in assigned mode).

Example:

"cus_a1b2c3d4e5f6g7h8"

data.picture

string<uri> | null

A URL to the organization's logo.

Example:

"https://cdn.altostrat.io/logos/engineering.png"

data.usage

object

Show child attributes

data.usage.usage

object

Usage consumed directly by this organization. Keys are meterable types (locations, users, sso).

Show child attributes

data.usage.usage.{key}

integer

Example:

{ "locations": 2, "users": 5 }

data.usage.subtree_usage

object

Total usage including this organization and all its descendants.

Show child attributes

data.usage.subtree_usage.{key}

integer

Example:

{ "locations": 10, "users": 25 }

data.limits

object

A map of resource limits applied directly to this organization. Keys are meterable types (locations, users, sso). A value of null or a missing key means no limit is set at this level. A value of 0 means the resource is explicitly disabled.

Show child attributes

data.limits.{key}

integer | null

Required range: x >= 0

Example:

{ "locations": 10, "users": 50 }

data.branding

object

Show child attributes

data.branding.display_name

string | null

The public-facing name of the organization, used for branding purposes.

Example:

"ACME Corp"

A unique, URL-friendly identifier used to pre-fill the organization in login flows.

Example:

"acme-corp"

data.branding.colors

object

A map of key-value pairs representing the organization's theme colors.

Show child attributes

data.branding.colors.{key}

string

Example:

{
  "primary": "#FF5733",
  "page_background": "#FFFFFF"
}

has_more

boolean

Example:

false

Update a member's role

Create an organization

⌘I

Getting Started

Platform & Identity

Device Management & Orchestration

Automation & AI

Network Services & Connectivity

Security & Threat Management

Monitoring & Analytics

Core Services & Utilities

List organizations

Authorizations

Path Parameters

Response