> ## 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 tags

> Filter vocabulary. Each tag has a `slug` (send in `extraTags` or stored in a filter set) and a `tagTypeKey` (send in `extraTagsNoneOf` to invert that type). Includes catalog types (market cap, sector, country, pitch category, strategy, format, source) and typed quality filters (author badge, author return, win rate, pitch return) plus sentiment, position, and paywall. Some catalog types nest children under a parent.



## OpenAPI

````yaml /openapi.json get /api/v1/tags
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/tags:
    get:
      tags:
        - Tags
      summary: List tags
      description: >-
        Filter vocabulary. Each tag has a `slug` (send in `extraTags` or stored
        in a filter set) and a `tagTypeKey` (send in `extraTagsNoneOf` to invert
        that type). Includes catalog types (market cap, sector, country, pitch
        category, strategy, format, source) and typed quality filters (author
        badge, author return, win rate, pitch return) plus sentiment, position,
        and paywall. Some catalog types nest children under a parent.
      operationId: listTags
      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
        - name: tagTypes
          in: query
          required: false
          description: >-
            Comma-separated type keys. Catalog types: `market_cap`,
            `sector_industry`, `country_region`, `pitch_category`, `strategy`,
            `content_format`, `source`. Quality and pitch attributes: `badge`,
            `author_return`, `win_rate`, `pitch_return`, `sentiment`,
            `position_decision`, `premium`. Omit to return all of them.
          schema:
            description: >-
              Comma-separated type keys. Catalog types: `market_cap`,
              `sector_industry`, `country_region`, `pitch_category`, `strategy`,
              `content_format`, `source`. Quality and pitch attributes: `badge`,
              `author_return`, `win_rate`, `pitch_return`, `sentiment`,
              `position_decision`, `premium`. Omit to return all of them.
            type: string
      responses:
        '200':
          description: Tag catalog
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        heading:
                          type: string
                          description: Type label, such as Strategy.
                        options:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Stable tag id.
                              slug:
                                type: string
                                description: >-
                                  Value to send in `extraTags` or stored in a
                                  filter set.
                              displayName:
                                type: string
                                description: Human-readable label.
                              shortName:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - slug
                              - displayName
                            additionalProperties: false
                      required:
                        - heading
                        - options
                      additionalProperties: false
                  sections:
                    type: array
                    items:
                      type: object
                      properties:
                        tagTypeKey:
                          type: string
                          description: >-
                            Type key for `extraTagsNoneOf` and for
                            `criteria.noneOf` on a filter set.
                        label:
                          type: string
                        hierarchy:
                          description: >-
                            Parent/child tags when the type is nested, such as
                            sector.
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Stable tag id.
                              slug:
                                type: string
                                description: >-
                                  Value to send in `extraTags` or stored in a
                                  filter set.
                              displayName:
                                type: string
                                description: Human-readable label.
                              shortName:
                                type:
                                  - string
                                  - 'null'
                              children:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      description: Stable tag id.
                                    slug:
                                      type: string
                                      description: >-
                                        Value to send in `extraTags` or stored
                                        in a filter set.
                                    displayName:
                                      type: string
                                      description: Human-readable label.
                                    shortName:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - slug
                                    - displayName
                                  additionalProperties: false
                            required:
                              - id
                              - slug
                              - displayName
                              - children
                            additionalProperties: false
                        flatOptions:
                          description: Tags when the type is a flat list.
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                description: Stable tag id.
                              slug:
                                type: string
                                description: >-
                                  Value to send in `extraTags` or stored in a
                                  filter set.
                              displayName:
                                type: string
                                description: Human-readable label.
                              shortName:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - slug
                              - displayName
                            additionalProperties: false
                      required:
                        - tagTypeKey
                        - label
                      additionalProperties: false
                required:
                  - groups
                  - sections
                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
        '500':
          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.