Skip to main content
GET
/
api
/
organisations
Get organisations for the current user
curl --request GET \
  --url https://api.mentionlab.io/api/organisations
[
  {
    "id": "01234567-89ab-cdef-0123-456789abcdef",
    "name": "My Company",
    "isDirectMember": true,
    "status": "active",
    "isSuperOrg": false,
    "features": [
      "chat-latest"
    ],
    "slug": "my-organisation",
    "config": {
      "logoUrlDark": "https://example.com/logo-dark.svg",
      "logoUrlLight": "https://example.com/logo-light.svg"
    },
    "role": "org_admin",
    "parentOrganisationId": "01234567-89ab-cdef-0123-456789abcdef"
  }
]

Response

id
string
required

Unique identifier for the organisation

Example:

"01234567-89ab-cdef-0123-456789abcdef"

name
string
required

Name of the organisation

Example:

"My Company"

isDirectMember
boolean
required

Whether the user is a direct member of the organisation

Example:

true

status
enum<string>
required

Account status (active / hard_suspended / frozen)

Available options:
active,
hard_suspended,
frozen
Example:

"active"

isSuperOrg
boolean
required

True iff this org has at least one child sub-org (i.e. is a super-org)

Example:

false

features
string[]
required

Client-visible feature flags granted to the org (e.g. model-gating flags). Empty when none.

Example:
["chat-latest"]
slug
string

Slug of the organisation

Example:

"my-organisation"

config
object

Organisation configuration details

role
enum<string>

Role of the user in the organisation (if direct member)

Available options:
org_admin,
org_editor,
org_viewer,
super_org_admin
Example:

"org_admin"

parentOrganisationId
string

Parent organisation id when this org is a sub-org. Absent for root orgs.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

billingMode
enum<string>

Billing mode for the org. Absent on sub-orgs (inherited from parent).

Available options:
stripe_self_serve,
stripe_partner,
partner_invoice