Org Management (Admin)

Organization management functions.

Retrieve a list of organizations for admin users.

get

This endpoint allows admin users to list all organizations within the system. It supports pagination through the 'limit' and 'start' parameters, enabling efficient data retrieval. Use this to manage organizational data effectively.

💻 Service Credentials is required to access this service.

🔒 Permission: org.directory.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

clientCredentials

OAuth2authorizationCodeRequired

An OIDC service account that was authenticated.

Token URL:

Query parameters

limitinteger · int32Optional

The maximum number of rows to return

Default: 1024

startinteger · int32Optional

The starting index for pagination.

Default: 0

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/directory/admin/orgs

HTTPcURLJavaScriptPython

GET /directory/admin/orgs HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "count": 1,
  "limit": 1,
  "skip": 1,
  "docs": [
    {
      "id": "text",
      "name": "text",
      "subdomain": "text",
      "domain": "text",
      "logo_url": "text",
      "owner": {
        "id": "text"
      },
      "creation_date": "2025-12-16T22:12:20.102Z",
      "modified_date": "2025-12-16T22:12:20.102Z",
      "contact": {
        "email": "text",
        "phone": "text",
        "url": "text"
      },
      "address": {
        "address_line_1": "text",
        "address_line_2": "text",
        "postal_code": "text",
        "city_ward": "text",
        "floor": "text",
        "usage": "residence",
        "building_name": "text",
        "state_prefecture": "text",
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "country_code": "US"
      },
      "children": [
        {
          "id": "text",
          "children": [
            "[Circular Reference]"
          ],
          "name": "text",
          "creation_date": "2025-12-16T22:12:20.102Z",
          "modified_date": "2025-12-16T22:12:20.102Z"
        }
      ],
      "status": "active",
      "external_sales_force_id": "text"
    }
  ]
}