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,
    "slug": "my-organisation",
    "config": {
      "logoUrlDark": "https://example.com/logo-dark.svg",
      "logoUrlLight": "https://example.com/logo-light.svg"
    },
    "role": "org_admin"
  }
]

Response

200 - application/json
​
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

​
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
Example:

"org_admin"