Skip to main content
GET
/
api
/
v1
/
org
/
organisation
/
{organisation_id}
Get organisation details
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)
{
  "organisation_id": "<string>",
  "users": [
    {
      "id": "<string>",
      "invite_id": "<string>",
      "email": "[email protected]",
      "status": "<string>",
      "role": "member",
      "user_current": true
    }
  ],
  "name": "<string>",
  "created_at": "<unknown>",
  "updated_at": "<unknown>",
  "user_current": false,
  "auto_upgrade_agent": false,
  "proactive_ai_insights_enabled": 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

Path Parameters

organisation_id
string<uuid4>
required

Response

Organisation retrieved successfully

organisation_id
string<uuid4>
required
users
OrganisationUser · object[]
required
name
string | null
created_at
any
updated_at
any
user_current
boolean
default:false
auto_upgrade_agent
boolean
default:false
proactive_ai_insights_enabled
boolean
default:false
user_is_admin
boolean
default:false