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

# Get alert filter options

> Return alert filter options derived from readable alerts, including Cotool and externally extracted detections.



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json get /api/alerts/filter-options
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    # Cotool API Documentation


    The Cotool API allows you to interact with the Cotool platform
    programmatically, enabling you to build powerful integrations and automate
    your workflows.


    ## Getting an API Key


    Follow these steps to generate your API key:


    1. **Log in** to the Cotool web interface

    2. **Navigate** to `/settings/api-keys`

    3. **Click** "Generate Key"

    4. **Copy and store** your API key securely ⚠️ *It won't be shown again*


    ## API Key Authentication


    For programmatic access and integrations, use your API key with the
    Authorization header:


    ```http

    Authorization: Bearer your_api_key_here

    ```


    ```bash

    curl -X GET "https://app.cotool.ai/api/endpoint" \
      -H "Authorization: Bearer your_api_key_here" \
      -H "Content-Type: application/json"
    ```
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/alerts/filter-options:
    get:
      tags:
        - Alerts
      summary: Get alert filter options
      description: >-
        Return alert filter options derived from readable alerts, including
        Cotool and externally extracted detections.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  detections:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          minLength: 1
                          description: >-
                            Opaque detection filter key accepted by the list
                            alerts endpoint
                        label:
                          type: string
                          minLength: 1
                          description: Human-readable detection name
                        kind:
                          type: string
                          enum:
                            - cotool
                            - external
                          description: >-
                            Whether this is a Cotool detection or an extracted
                            external detection
                        id:
                          type:
                            - string
                            - 'null'
                          format: uuid
                          description: Cotool detection id, when applicable
                        name:
                          type: string
                          minLength: 1
                          description: Detection name stored on alert rows
                        count:
                          type: integer
                          minimum: 0
                          description: Number of readable alerts for this detection filter
                      required:
                        - key
                        - label
                        - kind
                        - id
                        - name
                        - count
                    description: Detection filter options derived from readable alerts
                  sources:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          enum:
                            - cotool_detection
                            - hunting
                            - jira
                            - jira-automation
                            - slack
                            - linear
                            - cron
                            - webhook
                            - email
                            - bugcrowd
                            - hackerone
                          description: >-
                            Source filter key accepted by the list alerts
                            endpoint
                        category:
                          type: string
                          enum:
                            - detection
                            - trigger
                            - hunting
                          description: >-
                            Source category for the option (detection, trigger,
                            or hunting)
                        count:
                          type: integer
                          minimum: 0
                          description: Number of readable alerts for this source
                      required:
                        - name
                        - category
                        - count
                    description: Source filter options actually present on readable alerts
                required:
                  - detections
                  - sources
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: |-
            curl -X GET "https://app.cotool.ai/api/alerts/filter-options" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````