Skip to main content
GET
/
admin
/
organisations
List all organisations
curl --request GET \
  --url https://{tenant}/admin/organisations \
  --header 'Admin-Auth: <api-key>'
{
  "organisations": [
    {
      "additional_permissions": {},
      "apis": [
        {
          "api_human_name": "<string>",
          "api_id": "<string>"
        }
      ],
      "cname": "<string>",
      "cname_enabled": true,
      "developer_count": 123,
      "developer_quota": 123,
      "event_options": {},
      "hybrid_enabled": true,
      "id": "<string>",
      "open_policy": {
        "enabled": true,
        "rules": "<string>"
      },
      "org_options_meta": {},
      "owner_name": "<string>",
      "owner_slug": "<string>",
      "sso_enabled": true,
      "ui": {
        "cloud": true,
        "cloudmenu": true,
        "default_lang": "<string>",
        "designer": {},
        "dev": true,
        "dont_allow_license_management": true,
        "dont_allow_license_management_view": true,
        "dont_show_admin_sockets": true,
        "hide_help": true,
        "labs": {
          "streaming": {}
        },
        "languages": {},
        "login_page": {},
        "nav": {},
        "onboarding": {
          "enabled": true
        },
        "portal_section": {},
        "trial": {
          "end_date": 123,
          "hubspot_form": {
            "form_id": "<string>",
            "portal_id": "<string>",
            "region": "<string>"
          }
        },
        "uptime": {}
      }
    }
  ],
  "pages": 123
}

Authorizations

​
Admin-Auth
string
header
required

Api key

Response

Organisations retrieved successfully

​
organisations
object[] | null
​
pages
integer