/entitlements/report/organizations - Per-organization slice of the add-on report

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api.my.nethesis.it/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "my.nethesis.it MCP server": {
    "url": "https://api.my.nethesis.it/mcp"
  }
}

Close
GET /entitlements/report/organizations

Grants grouped by the organization owning the systems, most active first, paginated and searchable by organization name. Restricted to the caller's hierarchy (the whole fleet for the owner organization / a Super Admin).

Query parameters

  • page integer

    Default value is 1.

  • page_size integer

    Maximum value is 200. Default value is 10.

Responses

  • 200 application/json

    Report organizations retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • organizations array[object]
        Hide organizations attributes Show organizations attributes object
        • organization_id string
        • organization_name string
        • org_type string

          distributor | reseller | customer | owner

        • systems integer
        • active integer
        • total integer
      • total integer
      • page integer
      • page_size integer
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /entitlements/report/organizations
curl \
 --request GET 'https://api.your-domain.com/api/entitlements/report/organizations' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "code": 200,
  "message": "report organizations retrieved successfully",
  "data": {
    "organizations": [
      {
        "organization_id": "akkbs6x2wo82",
        "organization_name": "ACME S.r.l.",
        "org_type": "reseller",
        "systems": 12,
        "active": 18,
        "total": 20
      }
    ],
    "total": 130,
    "page": 1,
    "page_size": 10
  }
}
Response examples (401)
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403)
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}
Response examples (500)
{
  "code": 500,
  "message": "internal server error",
  "data": {}
}