/entitlements/grants/export - Export the grants report to CSV or PDF

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/grants/export

Export the grants report with the same filters as GET /entitlements/grants. With over_limit=true it is the list of add-ons past their tier (Owner organization only), widest overrun first.

Features:

  • Maximum 10,000 grants per export (DoS protection)
  • CSV: system id and key, system, product, organization, reseller, add-on, tier, usage, limit, overrun, measured at, order, status, valid until
  • PDF: formatted report with metadata and filters applied
  • File naming: addons_export_YYYY-MM-DD_HHmmss.[csv|pdf], addons_over_tier_export_... for the over-limit list

Query parameters

  • format string Required

    Export format

    Values are csv or pdf.

  • over_limit string

    When "true", only active grants past their tier limit. Owner organization only (ignored otherwise)

    Value is true.

  • entitlement string

    Filter by catalog id

  • organization_id string

    Filter by the organization owning the system

  • source string

    Filter by grant source

    Values are manual, shop, or legacy-import.

  • active string

    When "true", only active grants

    Value is true.

Responses

  • Export file generated successfully

    Hide headers attribute Show headers attribute
    • Content-Disposition string

      Attachment filename

  • 400

    Bad request (invalid format or too many grants)

  • 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
  • 429

    Another export is already running on this instance; retry after the number of seconds in Retry-After

GET /entitlements/grants/export
curl \
 --request GET 'https://my.nethesis.it/backend/api/entitlements/grants/export?format=csv' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (401)
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403)
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}