Query parameters

• format string Required

  Export format (csv or pdf)

  Values are csv or pdf.

• search string

  Search term. For organizations (distributors, resellers, customers), searches across name, description, and all custom_data fields (vat, address, city, contact, email, phone, language, notes, etc.). For systems, also searches across ipv4_address and ipv6_address.

  Minimum length is 1.

• sort_by string

  Field to sort applications by

  Values are display_name, module_id, instance_of, version, status, created_at, updated_at, last_inventory_at, system_name, organization_name, or certification_level.

• sort_direction string

  Sort direction

  Values are asc or desc. Default value is asc.

• type array[string]

  Filter applications by type (instance_of). Supports multiple values.

• version array[string]

  Filter applications by version. Supports multiple values. Uses prefixed format "application:version" (e.g., "nethvoice:1.5.3") to avoid ambiguity when the same version exists for multiple application types.

• system_id array[string]

  Filter applications by system ID. Supports multiple values.

• organization_id array[string]

  Filter applications by organization ID, matching the assigned organization or, for unassigned applications, the organization of the hosting system. Supports multiple values; combine with include_hierarchy to cover a whole subtree.

• include_hierarchy boolean

  When true (and organization_id is provided), each organization_id is expanded to the organization plus all its descendants (a distributor's resellers and their customers, a reseller's customers) before filtering

  Default value is false.

• status array[string]

  Filter applications by assignment status. Supports multiple values.

  Values are unassigned or assigned.

Responses

• 200

  text/csv

  text/csv application/pdf

  Export file generated successfully

  Hide headers attributes Show headers attributes

  • Content-Disposition string

    Attachment filename

  • Content-Length integer

    File size in bytes

  CSV file with applications data

  PDF report with applications data

• 400 application/json

  Bad request (invalid format or too many applications)

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object
    Hide data attributes Show data attributes object

    • total_count integer
    • max_limit 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
• 429 application/json

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

  Hide response attributes Show response attributes object

  • code integer
  • message string
  • data object
    Hide data attribute Show data attribute object

    • retry_after_seconds string