> ## 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 compliance alert filter catalog

> Return every criterion a compliance alert filter accepts — each with its `key`, `valueType`, allowed operations and live company values (the devices, platforms and owners that currently have an alert). This is the vocabulary for `searchComplianceAlerts`: use a criterion `key` as the filter key and one of its `values` inside the clause (`{"<key>":{"operationType":"INCLUDE","values":["<value>"]}}`). Call this first whenever you are unsure a criterion or a value exists — `searchComplianceAlerts` rejects an unknown key with 400. `ownerId` values are employee ids; resolve their names with `getEmployees`.

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


## OpenAPI

````yaml https://api.getprimo.com/openapi.json get /compliance/alerts/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:
  /compliance/alerts/filters-options:
    get:
      tags:
        - Compliance
      summary: Get the compliance alert filter catalog
      description: >-
        Return every criterion a compliance alert filter accepts — each with its
        `key`, `valueType`, allowed operations and live company values (the
        devices, platforms and owners that currently have an alert). This is the
        vocabulary for `searchComplianceAlerts`: use a criterion `key` as the
        filter key and one of its `values` inside the clause
        (`{"<key>":{"operationType":"INCLUDE","values":["<value>"]}}`). Call
        this first whenever you are unsure a criterion or a value exists —
        `searchComplianceAlerts` rejects an unknown key with 400. `ownerId`
        values are employee ids; resolve their names with `getEmployees`.
      operationId: getComplianceAlertsFilterCatalog
      parameters: []
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComplianceAlertsFilterCatalog_Output'
components:
  schemas:
    GetComplianceAlertsFilterCatalog_Output:
      type: object
      properties:
        filterOptions:
          type: array
          description: >-
            Every criterion the compliance alert list accepts. Build the
            `filter` of getComplianceAlerts by placing, under each option's
            `key`, a clause { operationType, values }.
          items:
            type: object
            properties:
              key:
                description: >-
                  The key to use in the `filter` object of
                  `getComplianceAlerts`.
                type: string
              kind:
                description: >-
                  Compliance alert criteria are all native — there are no custom
                  fields here.
                type: string
                const: native
              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:
                  [...] } under 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 clause `values` array.
                      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 filter supports OR across clauses. Criteria are ANDed
            when false.
      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>`.

````