Get Organization Report Filterable Fields

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Use a token with access to the organization reports features you need; this query returns the canonical list of primary filter fields used when configuring filters for organization reports.

Step 1: Query Organization Report Filterable Fields

Run the organizationReportFilterableFields query on the root Query type. It takes no arguments and returns one entry per primary organization-report field: a localized label, the internal name (use this when building filters), and the filter type (how the value should be handled in the UI or API). This operation is grouped with other report-related root queries in API v1 (same concern as organization reports, pipe reports, and pipe filterable fields).

{
  organizationReportFilterableFields {
    label
    name
    type
  }
}

Response Example

Labels depend on your locale (activerecord.attributes.card translations). Field names and types match the product definitions for organization reports.

{
  "data": {
    "organizationReportFilterableFields": [
      {
        "label": "Card ID",
        "name": "card_id",
        "type": "number"
      },
      {
        "label": "Title",
        "name": "title",
        "type": "string"
      },
      {
        "label": "Current phase",
        "name": "current_phase",
        "type": "group_select"
      },
      {
        "label": "Labels",
        "name": "labels",
        "type": "group_select"
      },
      {
        "label": "Due date",
        "name": "due_date",
        "type": "date"
      },
      {
        "label": "Created by",
        "name": "created_by",
        "type": "select"
      },
      {
        "label": "Creator email",
        "name": "creatorEmail",
        "type": "email"
      },
      {
        "label": "Assignees",
        "name": "assignees",
        "type": "select"
      },
      {
        "label": "Finished at",
        "name": "finished_at",
        "type": "date"
      },
      {
        "label": "Created at",
        "name": "created_at",
        "type": "date"
      },
      {
        "label": "Updated at",
        "name": "updated_at",
        "type": "date"
      },
      {
        "label": "Last comment",
        "name": "last_comment",
        "type": "string"
      },
      {
        "label": "Last comment at",
        "name": "last_comment_at",
        "type": "date"
      },
      {
        "label": "Pipe",
        "name": "repo",
        "type": "select"
      }
    ]
  }
}

Key Fields Explained

• label: Human-readable name for the field (localized).
• name: Internal identifier for the field; use this when defining or interpreting organization report filters.
• type: Expected filter control type. Common values include number, string, date, select, group_select, and email.

Use Cases

• Filter UI: Build dropdowns, date pickers, or multi-selects aligned with supported organization report filters.
• Report configuration: When creating or updating organization reports (for example via createOrganizationReport or update mutations), use name values from this list as a reference for valid primary filter fields.

For pipe-level report filters (different shape), see Get Pipe Report Filterable Fields in Report examples.

Notes

• No organization ID: The list describes the standard primary fields for organization reports; it is not scoped to a single organization.
• Schema grouping: In the Pipefy codebase, this field is implemented in ReportFields (app/graphql/types/root/root_queries/report_fields.rb) together with queries such as organizationReports, organizationReport, and pipe report helpers—not under organization-only root fields (OrganizationFields).
• Internal API: The same operation was previously exposed on the internal GraphQL API; prefer the root organizationReportFilterableFields field on the public API going forward.