Getting an organisation by ID¶

Sends a GET request to the endpoint /organisations/{organisation}.

Description¶

The Get-Organisation request returns a single organisation for a specified ID.

Requirements¶

Values of the request: Organisation ID {organisation}

Objects: none

Request¶

To request an organisation, add the Organisation ID {organisation} to the path of the request.

As a result, the user gets an object 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 original creation time in ISO 8601 format.	`string($date-time)`
`updated_at`	The time of the last update in ISO 8601 format.	`string($date-time)`
`users`	The users belonging to the organisation.	`array`
`emails`	The notification recipients of the organisation. Each entry contains the `id`, the `email` address, a `verified` flag, and the `verified_at` timestamp.	`array` of `object`
`showReports`	Defines whether mitigation reports are enabled.	`true` `false`
`siemEnabled`	Defines whether the SIEM integration is enabled.	`true` `false`
`anomaliesEnabled` (if anomalies enabled)	Whether the anomalies feature is enabled for this organisation, including email notifications for detected anomalies and for mitigations that start or stop.	`true` `false`
`customer_id` (if customer references enabled)	The identifier of the customer reference.	`string`
`customer_reference` (if customer references enabled)	The grouped customer reference.	`string`

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.
403	The request has not succeeded because the user does not have the right permissions.