Listing organisations with network and mitigation details¶

Note

The objects OrganisationVO are wrapped in data, supplemented by the pagination blocks links and meta.

Sends a GET request to the endpoint /organisations.

Description¶

The List-Organisations-Paginated request returns a paginated list of all organisations, enriched with network CIDRs and the current mitigation status.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a paginated 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 original creation timestamp in ISO 8601 format.	`string($date-time)`
`updated_at`	The last update timestamp in ISO 8601 format.	`string($date-time)`
`users`	The users assigned to the organisation.	`array`
`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`
`cidrs`	The comma-separated list of CIDRs.	`string`
`under_mitigation`	Shows whether a network is currently in mitigation.	`true` `false`
`customer_reference` (if customer references enabled)	The grouped customer reference.	`string`

Example¶

Example response:

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "https://datahub-api.com/api/networks?page=1",
    "last": "https://datahub-api.com/api/networks?page=5",
    "prev": null,
    "next": "https://datahub-api.com/api/networks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "https://datahub-api.com/api/networks?page=2",
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://datahub-api.com/api/networks",
    "per_page": 15,
    "to": 15,
    "total": 64
  }
}

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.