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

# List saved filter sets

> Filter sets the key owner has already saved. Each item is a named combination of tags. Pass `id` as `filterSetIds` on GET /api/v1/pitches. This endpoint lists sets; it does not create or edit them. Several set ids on the pitch list are OR'd; they AND with `extraTags` and the other pitch filters.



## OpenAPI

````yaml /openapi.json get /api/v1/filter-sets
openapi: 3.1.0
info:
  title: Yellowbrick API
  version: 1.0.0
  description: >-
    Find companies and authors, read the tag vocabulary, reuse saved filter
    sets, then list or fetch pitches. The key identifies a Premium account. That
    account's access still applies on every request.
servers:
  - url: https://www.joinyellowbrick.com
    description: Production
  - url: https://yellowbrick-staging.vercel.app
    description: Staging
security:
  - bearerAuth: []
tags:
  - name: Search
    description: >-
      Look up companies and authors by name, ticker, username, or display name.
      Use the ids you get on the pitch list.
  - name: Tags
    description: >-
      Catalog of filter slugs and type keys, including author badge, author
      return, win rate, and pitch return. Send `slug` as `extraTags` or use the
      typed pitch-list parameters.
  - name: Filter Sets
    description: >-
      Saved tag combinations on the key owner's account. Pass an `id` as
      `filterSetIds` on the pitch list.
  - name: Pitches
    description: >-
      List write-ups that match search ids, tags, and filter sets, or fetch one
      pitch by id.
paths:
  /api/v1/filter-sets:
    get:
      tags:
        - Filter Sets
      summary: List saved filter sets
      description: >-
        Filter sets the key owner has already saved. Each item is a named
        combination of tags. Pass `id` as `filterSetIds` on GET /api/v1/pitches.
        This endpoint lists sets; it does not create or edit them. Several set
        ids on the pitch list are OR'd; they AND with `extraTags` and the other
        pitch filters.
      operationId: listFilterSets
      parameters:
        - name: x-vercel-protection-bypass
          in: query
          required: false
          description: >-
            Optional. Vercel Protection Bypass for Automation — use when calling
            the Staging server.
          schema:
            type: string
      responses:
        '200':
          description: Saved filter sets
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Pass as `filterSetIds` on GET /api/v1/pitches.
                        displayName:
                          type: string
                          description: Name the key owner saved.
                        criteria:
                          type: object
                          properties:
                            mode:
                              type: string
                              const: simple
                            tags:
                              type: object
                              properties:
                                any:
                                  type: array
                                  items:
                                    type: string
                                  description: >-
                                    Tag slugs in this set when `tagsByType` is
                                    empty.
                              required:
                                - any
                              additionalProperties: false
                            tagsByType:
                              description: >-
                                Slugs grouped by tag type key. OR within a type,
                                AND across types.
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type: array
                                items:
                                  type: string
                            selectedTagTypeKeys:
                              type: array
                              items:
                                type: string
                            noneOf:
                              description: >-
                                Tag type keys to invert in this set. A pitch
                                must not match that type's slugs.
                              type: array
                              items:
                                type: string
                            author:
                              type: object
                              properties:
                                userId:
                                  type: string
                                  description: >-
                                    Stable author user id from GET
                                    /api/v1/search.
                                username:
                                  type: string
                                displayName:
                                  type: string
                                noneOf:
                                  description: When true, exclude this author.
                                  type: boolean
                              required:
                                - userId
                              additionalProperties: false
                            company:
                              type: object
                              properties:
                                companyId:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                  description: Stable company id from GET /api/v1/search.
                                ticker:
                                  type: string
                                companyName:
                                  type: string
                                noneOf:
                                  description: When true, exclude this company.
                                  type: boolean
                              required:
                                - companyId
                              additionalProperties: false
                            keyword:
                              type: object
                              properties:
                                value:
                                  type: string
                                  minLength: 2
                                  maxLength: 80
                                  description: >-
                                    Keyword matched against pitch text, author,
                                    and tags.
                                noneOf:
                                  description: >-
                                    When true, exclude pitches that match this
                                    keyword.
                                  type: boolean
                              required:
                                - value
                              additionalProperties: false
                          required:
                            - mode
                            - tags
                          additionalProperties: false
                      required:
                        - id
                        - displayName
                        - criteria
                      additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '401':
          description: Problem details (`type`, `title`, `status`, `detail`).
          content:
            application/problem+json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  type:
                    type: string
                    description: Stable error code, such as `premium-required`.
                  title:
                    type: string
                    description: Short label for the error.
                  status:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: HTTP status code.
                  detail:
                    type: string
                    description: Human-readable explanation.
                required:
                  - type
                  - title
                  - status
                  - detail
                additionalProperties: false
        '403':
          description: Problem details (`type`, `title`, `status`, `detail`).
          content:
            application/problem+json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  type:
                    type: string
                    description: Stable error code, such as `premium-required`.
                  title:
                    type: string
                    description: Short label for the error.
                  status:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: HTTP status code.
                  detail:
                    type: string
                    description: Human-readable explanation.
                required:
                  - type
                  - title
                  - status
                  - detail
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Key from Profile. Send `Authorization: Bearer yb_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.