GET
/
admin
/
organisations
/
{orgID}
Retrieve a single organisation
curl --request GET \
  --url https://{tenant}/admin/organisations/{orgID} \
  --header 'Admin-Auth: <api-key>'
{
  "apis": [
    {
      "api_human_name": "API 2",
      "api_id": "5fa2db834e07444f760b7ceb314209fb"
    },
    {
      "api_human_name": "API 1",
      "api_id": "7a6ddeca9244448a4233866938a0d6e2"
    },
    {
      "api_human_name": "API 3",
      "api_id": "109eacaa50b24b64651a1d4dce8ec385"
    }
  ],
  "cname": "my.domain.com",
  "cname_enabled": true,
  "developer_count": 21,
  "developer_quota": 123,
  "event_options": {
    "key_event": {
      "email": "",
      "redis": true,
      "webhook": ""
    },
    "key_request_event": {
      "email": "",
      "redis": false,
      "webhook": ""
    }
  },
  "hybrid_enabled": false,
  "id": "53ac07777cbb8c2d53000002",
  "owner_name": "Test",
  "owner_slug": "test",
  "ui": {
    "default_lang": "",
    "designer": {},
    "dont_allow_license_management": false,
    "dont_allow_license_management_view": false,
    "dont_show_admin_sockets": false,
    "hide_help": false,
    "languages": {},
    "login_page": {},
    "nav": {},
    "portal_section": {},
    "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 | null
​
apis
object[] | null
​
cname
string
​
cname_enabled
boolean
​
developer_count
integer
​
developer_quota
integer
​
event_options
object | null
​
hybrid_enabled
boolean
​
id
string
​
open_policy
object
​
org_options_meta
object | null
​
owner_name
string
​
owner_slug
string
​
sso_enabled
boolean
​
ui
object