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 systems by

  Values are name, type, status, fqdn, version, system_key, created_at, updated_at, creator_name, or organization_name.

• sort_direction string

  Sort direction

  Values are asc or desc. Default value is asc.

• name string

  Filter systems by name (case-insensitive, partial match)

• system_key string

  Filter systems by system key (exact match). Useful for exporting a single system.

• type array[string]

  Filter systems by type/product (exact match). Supports multiple values for checkbox filtering.

• created_by array[string]

  Filter systems by creator user ID or creator organization ID (exact match). Each provided ID is checked against both the user_id and organization_id fields of the system creator. Supports multiple values for checkbox filtering.

  Examples:

  • ?created_by=53h5zxpwu4vc - matches systems created by user with ID 53h5zxpwu4vc
  • ?created_by=lbswt1rxdhbz - matches systems created by users in organization lbswt1rxdhbz
  • ?created_by=53h5zxpwu4vc&created_by=lbswt1rxdhbz - matches systems created by the user OR by users in the organization
• version array[string]

  Filter systems by version using prefixed format product:version (e.g., nsec:8.0, ns8:1.2.3). The prefix prevents ambiguity when the same version number exists for multiple products. Supports multiple values for checkbox filtering.

  Example: ?version=nsec:8.0&version=ns8:1.2.3 matches systems with (nsec version 8.0) OR (ns8 version 1.2.3)

  Backward compatibility: Non-prefixed versions (e.g., 8.0) are still supported but may match multiple products.

• organization_id array[string]

  Filter systems by organization ID (exact match). Supports multiple values for checkbox filtering.

• status array[string]

  Filter systems by status. Supports multiple values.

  • unknown, active, inactive, deleted: match the system status column
  • suspended: virtual status matching systems with suspended_at IS NOT NULL

  Special value "deleted" shows soft-deleted systems (where deleted_at IS NOT NULL). When "deleted" is combined with other statuses, both deleted and non-deleted systems matching the other statuses are returned.

  Values are unknown, active, inactive, suspended, or deleted.

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 systems data

  PDF report with systems data

• 400 application/json

  Bad request (invalid format or too many systems)

  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