List organisations

GET /api/v1/org/organisation

List organisations

Python

import requests

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

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

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

print(response.text)

200

[
  {
    "organisation_id": "<string>",
    "name": "<string>",
    "role": "member",
    "slug": "<string>",
    "status": "<string>",
    "user_current": 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

Response

200

application/json

Organisations retrieved successfully

organisation_id · string<uuid4> · required

name · string | null

role · enum<string> | null

Available options: member, admin, read-only

slug · string | null

status · string | null

user_current · boolean · default: false