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

> Your dictionary of named entities (podcasts, people, publications, AI assistants…) by name, cursor-paginated. `status=pending` lists the proposed entities waiting in the review queue.



## OpenAPI

````yaml /openapi.json get /v1/entities
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/entities:
    get:
      tags:
        - Taxonomy
      summary: List entities
      description: >-
        Your dictionary of named entities (podcasts, people, publications, AI
        assistants…) by name, cursor-paginated. `status=pending` lists the
        proposed entities waiting in the review queue.
      parameters:
        - schema:
            type: string
            enum:
              - approved
              - pending
              - rejected
            default: approved
          required: false
          description: >-
            `approved` (default) for the dictionary, `pending` for proposed
            entities in the review queue, or `rejected`.
          name: status
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 64
          required: false
          description: Only entities whose home channel is this slug, e.g. `podcast`.
          name: channel
          in: query
        - schema:
            type: string
            maxLength: 200
          required: false
          description: Search names.
          name: q
          in: query
        - schema:
            type: string
          required: false
          description: The `next_cursor` from the previous page.
          name: cursor
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 100
          required: false
          description: Page size, 1–200. Default 100.
          name: limit
          in: query
      responses:
        '200':
          description: A page of entities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Entity'
                  next_cursor:
                    type:
                      - string
                      - 'null'
                required:
                  - data
                  - next_cursor
        '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:
    Entity:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Lenny's Podcast
        kind:
          type: string
          enum:
            - person
            - ai_assistant
            - podcast
            - publication
            - community
            - search_engine
            - review_site
            - ad_network
            - event
            - company
            - other
        channel:
          type: string
          description: Slug of the entity's home channel.
          example: podcast
        aliases:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - approved
            - pending
            - rejected
          description: >-
            `approved` entities are in the dictionary; `pending` ones are
            proposed entities waiting in the review queue.
        is_global:
          type: boolean
          description: >-
            In every workspace's dictionary (AI assistants, search engines,
            review sites).
        response_count:
          type: integer
          description: >-
            Responses linked to it; for a pending entity, responses that
            proposed the name.
        created_at:
          type: string
          format: date-time
      required:
        - id
        - name
        - kind
        - channel
        - aliases
        - status
        - is_global
        - response_count
        - created_at
    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.