Skip to main content
GET
/
admin
/
organisations
/
{orgID}
Retrieve a single organisation
curl --request GET \
  --url https://{tenant}/admin/organisations/{orgID} \
  --header 'Admin-Auth: <api-key>'
{
  "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": {}
  }
}

Authorizations

​
Admin-Auth
string
header
required

Api key

Path Parameters

​
orgID
string
required

Organisation ID of the org to add, update, or delete.

Response

Organisation retrieved

​
additional_permissions
object
​
apis
object[] | null
​
cname
string
​
cname_enabled
boolean
​
developer_count
integer
​
developer_quota
integer
​
event_options
object
​
hybrid_enabled
boolean
​
id
string
​
open_policy
object
​
org_options_meta
object
​
owner_name
string
​
owner_slug
string
​
sso_enabled
boolean
​
ui
object