Get organisation details

GET /api/v1/org/organisation/{organisation_id}

Get organisation details

Python

import requests

url = "https://platform.ankra.app/api/v1/org/organisation/{organisation_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "organisation_id": "<string>",
  "users": [
    {
      "email": "[e-mail]",
      "id": "<string>",
      "invite_id": "<string>",
      "role": "member",
      "status": "<string>",
      "user_current": true,
      "service_principal_kind": "<string>",
      "service_principal_name": "<string>"
    }
  ],
  "ai_insight_exclude_system_namespaces": true,
  "ai_insight_high_restart_recency_hours": 123,
  "ai_insight_high_restart_threshold": 123,
  "auto_upgrade_agent": false,
  "created_at": "<unknown>",
  "mfa_required": false,
  "name": "<string>",
  "proactive_ai_insights_enabled": false,
  "security_baseline_enabled": true,
  "slug": "<string>",
  "updated_at": "<unknown>",
  "user_current": false,
  "user_is_admin": false
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

organisation_id · string<uuid4> · required

Response

200

application/json

Organisation retrieved successfully

organisation_id · string<uuid4> · required

users · OrganisationUser · object[] · required

Show child attributes

ai_insight_exclude_system_namespaces · boolean | null

ai_insight_high_restart_recency_hours · integer | null

ai_insight_high_restart_threshold · integer | null

auto_upgrade_agent · boolean · default: false

created_at · any

mfa_required · boolean · default: false

name · string | null

proactive_ai_insights_enabled · boolean · default: false

security_baseline_enabled · boolean | null

slug · string | null

updated_at · any

user_current · boolean · default: false

user_is_admin · boolean · default: false