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

# List channels

> Your taxonomy: every channel in sort order, archived ones included. The `slug` is what responses, reports and filters use.



## OpenAPI

````yaml /openapi.json get /v1/channels
openapi: 3.1.0
info:
  title: Rumorly API
  version: 1.0.0
  description: >-
    Send "how did you hear about us?" answers in; get channels, named entities
    and revenue out. All JSON is snake_case.
servers:
  - url: https://api.rumorly.io
    description: Production
security: []
tags:
  - name: Basics
  - name: Responses
    description: Answers and their classification.
  - name: Taxonomy
    description: Your channels and your dictionary of named entities.
  - name: People
    description: The people who answered.
  - name: Reports
    description: Revenue by self-reported channel.
  - name: Snippet
    description: Endpoints the JS snippet calls.
paths:
  /v1/channels:
    get:
      tags:
        - Taxonomy
      summary: List channels
      description: >-
        Your taxonomy: every channel in sort order, archived ones included. The
        `slug` is what responses, reports and filters use.
      responses:
        '200':
          description: The channels.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Channel'
                required:
                  - data
        '400':
          description: The body or query failed validation; `issues` says which field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            `plan_required`: your plan doesn't include API access (Growth and
            up; the signup trial does). `no_plan`: the workspace has no active
            plan (trial ended or subscription lapsed) and is paused until one is
            chosen. `quota_exceeded` (POST only): this month's response
            allowance is used up.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key is not allowed to do this (e.g. a publishable key reading
            data).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - secretKey: []
components:
  schemas:
    Channel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
          description: Stable id used everywhere else (`channel` on responses and reports).
          example: podcast
        label:
          type: string
          example: Podcast
        description:
          type: string
        sort_order:
          type: integer
          description: Position in the dashboard and reports, ascending.
        archived:
          type: boolean
          description: >-
            No longer offered to the classifier; older responses may still name
            it.
        is_default:
          type: boolean
          description: One of Rumorly's built-in channels (vs. one the workspace added).
      required:
        - id
        - slug
        - label
        - description
        - sort_order
        - archived
        - is_default
    Error:
      type: object
      properties:
        error:
          type: string
          example: invalid body
        code:
          type: string
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: >-
        A secret key (`sk_live_…` / `sk_test_…`) from Settings → API keys.
        Server-side only.

````

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