Listing all organisations of the user¶
Sends a GET request to the endpoint /organisations/all.
Description¶
The List-Organisations request returns a list of all organisations to which the user has access.
Requirements¶
Values of the request: none
Objects: none
Request¶
To request a list of all organisations, no additional information is required in the path of the request.
As a result, the user gets one or more objects OrganisationVO with the requested information.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
id |
The ID of the organisation. | string |
name |
The name of the organisation. | string |
created_at |
The creation date in ISO 8601 format. | string($date-time) |
updated_at |
The last modification date in ISO 8601 format. | string($date-time) |
The response is not paginated.
Example¶
Example response:
[
{
"id": "xY9pQ5wR1",
"name": "Test Organisation",
"created_at": "2026-01-01T00:00:00+00:00",
"updated_at": "2026-01-01T00:00:00+00:00",
"users": [
{
"id": "xY9pQ5wR1",
"name": "Max Mustermann",
"email": "max@mustermann.de",
"has2Fa": false,
"permissions": {},
"activeOrganisation": {
"id": "xY9pQ5wR1",
"name": "Test Organisation"
},
"hasActiveMitigations": false,
"hasSiem": false,
"invitedSince": "2024-01-15 10:30:00",
"status": "active",
"role": "admin",
"teams": [
{
"id": "xY9pQ5wR1",
"name": "Test Organisation"
}
],
"teams_as_admin": [
{
"id": "xY9pQ5wR1",
"name": "Test Organisation"
}
],
"features": [
{
"name": "L_NUMBER",
"value": null,
"enabled": 1
}
]
}
],
"showReports": true,
"siemEnabled": false,
"customer_id": "abc",
"cidrs": "127.0.0.1/32, 10.0.0.0/24",
"under_mitigation": false,
"customer_reference": "abc"
}
]
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 401 | The request has not succeeded because the user authentication was incorrect. |