> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the device group filter catalog

> Return every criterion (native device attributes plus custom fields) that may target a device group, with its live company values inline. Use this to build a valid device-group target.

<span className="badge-read">Key: Read</span><span className="badge-company">Scope: Company</span>


## OpenAPI

````yaml https://api.getprimo.com/openapi.json get /device-groups/filters-options
openapi: 3.1.1
info:
  title: Public API - BETA
  description: Read docs on https://docs.getprimo.com/
  version: '1.0'
  contact: {}
servers:
  - url: https://api.getprimo.com
security:
  - apikey: []
tags: []
paths:
  /device-groups/filters-options:
    get:
      tags:
        - DeviceGroups
      summary: Get the device group filter catalog
      description: >-
        Return every criterion (native device attributes plus custom fields)
        that may target a device group, with its live company values inline. Use
        this to build a valid device-group target.
      operationId: getDeviceGroupFiltersOptions
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeviceGroupFiltersOptions_Output'
components:
  schemas:
    GetDeviceGroupFiltersOptions_Output:
      type: object
      properties:
        filterOptions:
          type: array
          description: >-
            Every criterion that may target a device group. Build the target by
            placing, at each option's `key`, a clause { operationType, values };
            add top-level `matchAny: true` for OR across clauses.
          items:
            type: object
            properties:
              key:
                description: >-
                  For a native criterion, the path inside the device-group
                  target where the clause is written (e.g. "owner.teamIds",
                  "health.batteryHealth"). For a custom field, the
                  customFieldId.
                type: string
              kind:
                description: >-
                  Whether this option targets a native device attribute or a
                  custom field.
                type: string
                enum:
                  - native
                  - custom_field
              valueType:
                description: >-
                  How many values the clause accepts: multiple, exactly one, or
                  a boolean flag.
                type: string
                enum:
                  - multi_select
                  - single_select
                  - flag
              operationTypes:
                description: >-
                  The values allowed for the clause's `operationType` field. A
                  clause is written as { operationType: <one of these>, values:
                  [...] } at this option's `key`.
                type: array
                items:
                  type: string
                  enum:
                    - INCLUDE
                    - EXCLUDE
              supportsEmpty:
                description: Whether this criterion can match the "unset" case.
                type: boolean
              description:
                description: Human-readable description of what this criterion filters on.
                type: string
              values:
                description: >-
                  The allowed values for this option, with live company data
                  inline.
                type: array
                items:
                  description: One allowed value of a Filter option.
                  type: object
                  properties:
                    value:
                      description: The raw value to write into the target clause.
                      type: string
                    label:
                      description: >-
                        Human-readable label. For static enum values this equals
                        `value`.
                      type: string
                  required:
                    - value
                    - label
                  additionalProperties: false
            required:
              - key
              - kind
              - valueType
              - operationTypes
              - supportsEmpty
              - description
              - values
            additionalProperties: false
        supportsMatchAny:
          type: boolean
          description: Whether the target supports the top-level matchAny (OR) toggle.
      required:
        - filterOptions
        - supportsMatchAny
      additionalProperties: false
  securitySchemes:
    apikey:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Use your Primo API key in the Authorization header as `Bearer
        <API_KEY>`.

````