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

# Listar ideias

> Lista as ideias do workspace, das mais novas para as mais antigas, com mídias e etiquetas. Os filtros de etapa (`stages[]`, `unassigned`) trazem as ideias que se encaixam em qualquer um deles, e os filtros de etiqueta (`labels[]`, `untagged`) funcionam do mesmo jeito. Os dois grupos se combinam com E. O tamanho da página é definido pelo servidor: leia `meta.per_page`.



## OpenAPI

````yaml /openapi.json get /ideas
openapi: 3.1.0
info:
  title: PostClean API
  version: 2.0.0
  description: >-
    API REST do PostClean. Autentique com uma chave de API do workspace, enviada
    como token Bearer no cabeçalho `Authorization`.
servers:
  - url: https://post.chatclean.com.br/api
    description: PostClean
security:
  - bearerAuth: []
tags:
  - name: Posts
    description: Criar, ler, atualizar, excluir e pré-visualizar posts.
  - name: Post notes
    description: Notas internas de um post, visíveis aos membros do workspace.
  - name: Approvals
    description: Aprovar ou rejeitar posts que aguardam aprovação.
  - name: Recurrence
    description: Fazer um post se repetir numa frequência.
  - name: Media and uploads
    description: Enviar arquivos e anexar mídia aos posts.
  - name: Social accounts
    description: Contas sociais conectadas e as opções de cada rede.
  - name: Channels
    description: Horários de postagem e fila de um canal.
  - name: Ideas
    description: Ideias do quadro Criar.
  - name: Idea stages
    description: As colunas (etapas) do quadro de ideias.
  - name: Analytics
    description: Métricas do workspace e dos canais.
  - name: Labels
    description: Etiquetas para organizar posts e ideias.
  - name: Signatures
    description: Textos reutilizáveis para adicionar aos posts.
  - name: Workspace
    description: O workspace ao qual a chave de API pertence.
  - name: API keys
    description: Chaves de API pessoais deste workspace.
  - name: Webhooks
    description: Webhooks de saída e os registros de entrega.
  - name: Repurposes
    description: Automações que republicam vídeos postados fora do PostClean.
  - name: Platform
    description: Recursos de cada plataforma e tipos de conteúdo.
paths:
  /ideas:
    get:
      tags:
        - Ideas
      summary: Listar ideias
      description: >-
        Lista as ideias do workspace, das mais novas para as mais antigas, com
        mídias e etiquetas. Os filtros de etapa (`stages[]`, `unassigned`)
        trazem as ideias que se encaixam em qualquer um deles, e os filtros de
        etiqueta (`labels[]`, `untagged`) funcionam do mesmo jeito. Os dois
        grupos se combinam com E. O tamanho da página é definido pelo servidor:
        leia `meta.per_page`.
      operationId: listIdeas
      parameters:
        - name: stages[]
          in: query
          required: false
          style: form
          explode: true
          description: >-
            Só as ideias destas etapas. Valores que não são UUID são ignorados.
            Envie como lista (`stages[]=…`): um valor único sem `[]` retorna
            `422`.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: unassigned
          in: query
          required: false
          description: >-
            Inclui (ou traz só) as ideias sem etapa. `true`, `1`, `yes` ou `on`
            ligam o filtro; qualquer outro valor desliga.
          schema:
            type: boolean
        - name: labels[]
          in: query
          required: false
          style: form
          explode: true
          description: >-
            Só as ideias com alguma destas etiquetas. Valores que não são UUID
            são ignorados. Envie como lista (`labels[]=…`): um valor único sem
            `[]` retorna `422`.
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: untagged
          in: query
          required: false
          description: >-
            Inclui (ou traz só) as ideias sem etiqueta. `true`, `1`, `yes` ou
            `on` ligam o filtro; qualquer outro valor desliga.
          schema:
            type: boolean
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Uma página de ideias.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Idea'
                  links:
                    $ref: '#/components/schemas/PaginationLinks'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
              example:
                data:
                  - id: 9e2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                    idea_stage_id: 9e1a2b3c-4d5e-4f6a-8b7c-9d0e1f2a3b4c
                    title: Bastidores do lançamento da versão 2.0
                    body: >-
                      Mostrar a equipe, o quadro branco e o primeiro rascunho do
                      novo editor.
                    position: 0
                    media:
                      - id: 9e2b3c50-7a8b-4c9d-8e0f-1a2b3c4d5e6f
                        path: medias/9e2b3c50-7a8b-4c9d-8e0f-1a2b3c4d5e6f.jpg
                        url: >-
                          https://example.com/medias/9e2b3c50-7a8b-4c9d-8e0f-1a2b3c4d5e6f.jpg
                        type: image
                        mime_type: image/jpeg
                        original_filename: quadro-branco.jpg
                        size: 351204
                        meta:
                          width: 1600
                          height: 1200
                    labels:
                      - id: 9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f
                        name: Lançamento
                        color: '#2563EB'
                        created_at: '2026-09-01 10:00:00'
                        updated_at: '2026-09-01 10:00:00'
                    created_at: '2026-10-07 18:20:00'
                    updated_at: '2026-10-07 18:20:00'
                links:
                  first: https://post.chatclean.com.br/api/ideas?page=1
                  last: https://post.chatclean.com.br/api/ideas?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '« Previous'
                      page: null
                      active: false
                    - url: https://post.chatclean.com.br/api/ideas?page=1
                      label: '1'
                      page: 1
                      active: true
                    - url: null
                      label: Next »
                      page: null
                      active: false
                  path: https://post.chatclean.com.br/api/ideas
                  per_page: 25
                  to: 1
                  total: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    Idea:
      type: object
      properties:
        id:
          type: string
          format: uuid
        idea_stage_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Etapa (coluna do quadro) da ideia. `null` significa Sem etapa.
        title:
          type:
            - string
            - 'null'
        body:
          type:
            - string
            - 'null'
        position:
          type: integer
          description: Posição dentro da etapa, começando em 0.
        media:
          type: array
          items:
            $ref: '#/components/schemas/MediaItem'
        labels:
          type: array
          items:
            $ref: '#/components/schemas/Label'
        created_at:
          type: string
          description: Em UTC, no formato `Y-m-d H:i:s`.
          examples:
            - '2026-10-07 18:20:00'
        updated_at:
          type: string
          description: Em UTC, no formato `Y-m-d H:i:s`.
          examples:
            - '2026-10-07 18:20:00'
    PaginationLinks:
      type: object
      properties:
        first:
          type:
            - string
            - 'null'
        last:
          type:
            - string
            - 'null'
        prev:
          type:
            - string
            - 'null'
        next:
          type:
            - string
            - 'null'
      description: Links para a primeira, a última, a anterior e a próxima página.
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
          description: Página atual.
        from:
          type:
            - integer
            - 'null'
        last_page:
          type: integer
          description: Última página.
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type:
                  - string
                  - 'null'
              label:
                type: string
              page:
                type:
                  - integer
                  - 'null'
              active:
                type: boolean
          description: Links de navegação entre páginas.
        path:
          type: string
        per_page:
          type: integer
          description: >-
            Tamanho da página definido pelo servidor (hoje 25). Leia o valor em
            vez de supor.
        to:
          type:
            - integer
            - 'null'
        total:
          type: integer
          description: Total de itens em todas as páginas.
      description: Dados da página atual de uma lista paginada.
    MediaItem:
      type: object
      description: Um item de mídia como fica salvo no post.
      properties:
        id:
          type: string
          format: uuid
          description: >-
            Id da mídia. Passe como `media[].id` para usar o arquivo em outro
            post.
        path:
          type: string
          description: Caminho no armazenamento, `medias/{uuid}.{ext}`.
        url:
          type: string
          format: uri
          description: URL pública do arquivo.
        type:
          type:
            - string
            - 'null'
          enum:
            - image
            - video
            - document
            - null
          description: '`null` em itens antigos, salvos sem tipo.'
        mime_type:
          type:
            - string
            - 'null'
          description: Tipo MIME do arquivo.
        original_filename:
          type:
            - string
            - 'null'
          description: Nome original do arquivo.
        size:
          type:
            - integer
            - 'null'
          description: Tamanho em bytes.
        meta:
          $ref: '#/components/schemas/MediaItemMeta'
        source:
          type:
            - string
            - 'null'
          enum:
            - ai
            - unsplash
            - google_drive
            - google_photos
            - canva
            - null
          description: >-
            De onde o arquivo veio no app. Só aparece em itens adicionados por
            uma dessas fontes.
        source_meta:
          type:
            - object
            - 'null'
          description: Detalhes dessa fonte. Só aparece quando a fonte informou algum.
      examples:
        - id: 9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f
          path: medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg
          url: https://example.com/medias/9d3c1f30-8a9b-4c0d-9e1f-2a3b4c5d6e7f.jpg
          type: image
          mime_type: image/jpeg
          original_filename: lancamento.jpg
          size: 482113
          meta:
            width: 1080
            height: 1350
            alt_text: Banner de lançamento do produto
    Label:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        color:
          type: string
          description: Cor em hexadecimal, `#RRGGBB`.
          examples:
            - '#2563EB'
        created_at:
          type: string
          description: Em UTC, no formato `Y-m-d H:i:s`.
          examples:
            - '2026-09-01 10:00:00'
        updated_at:
          type: string
          description: Em UTC, no formato `Y-m-d H:i:s`.
          examples:
            - '2026-09-01 10:00:00'
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    ValidationErrorBody:
      type: object
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      description: Corpo de erro de validação. `errors` traz as mensagens por campo.
    RateLimitErrorBody:
      type: object
      properties:
        name:
          type: string
          const: rate_limit_exceeded
        message:
          type: string
          examples:
            - Rate limit exceeded. Please retry after 30 seconds.
      description: Corpo devolvido quando o limite de requisições é excedido.
    MediaItemMeta:
      type: object
      description: >-
        Configurações editáveis de um item de mídia. As respostas também podem
        trazer chaves medidas pelo servidor (por exemplo `width`, `height` e
        `duration`).
      properties:
        alt_text:
          type: string
          maxLength: 2000
          description: >-
            Descrição de acessibilidade. Vale para imagens; cada rede corta no
            próprio limite.
        user_tags:
          type: array
          maxItems: 20
          description: Pessoas marcadas numa imagem do Instagram (só `instagram_feed`).
          items:
            type: object
            required:
              - username
              - x
              - 'y'
            properties:
              username:
                type: string
                pattern: ^@?[A-Za-z0-9._]{1,30}$
                description: >-
                  Nome de usuário público do Instagram. Um `@` no início é
                  removido.
              x:
                type: number
                minimum: 0
                maximum: 1
                description: Distância da borda esquerda, de 0 a 1.
              'y':
                type: number
                minimum: 0
                maximum: 1
                description: Distância da borda de cima, de 0 a 1.
        cover_offset_ms:
          type: integer
          minimum: 0
          description: >-
            Quadro do vídeo usado como capa, em milissegundos a partir do
            início. Não pode passar do fim do vídeo.
  responses:
    Unauthorized:
      description: >-
        Chave de API ausente, inválida, revogada ou expirada. Corpos possíveis:
        `Unauthenticated.` (sem chave, ou chave inválida ou revogada), `Token
        expired.` (passou do `expires_at`), `Token not found.` e `No workspace
        selected.` (a chave não está mais ligada a um workspace).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Unauthenticated.
    PaymentRequired:
      description: >-
        A conta do workspace não tem assinatura ativa nem período de teste.
        Corpo: `{"message": "Active subscription required."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            message: Active subscription required.
    Forbidden:
      description: >-
        A requisição não é permitida. Chaves de API só funcionam para
        administradores do workspace (o dono da conta ou um membro marcado como
        administrador); fora isso, toda requisição devolve `Insufficient
        workspace permissions.`. Outros corpos: `Workspace access denied.` (o
        usuário da chave saiu do workspace), `Personal access token required.`
        (foi enviado um token OAuth do MCP) e `This action is unauthorized.`
        (por exemplo, a nota pertence a outro membro).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    ValidationError:
      description: A validação falhou. Cada campo com erro aparece em `errors`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorBody'
    TooManyRequests:
      description: 'Limite de requisições excedido: 60 por minuto por workspace.'
      headers:
        Retry-After:
          description: Segundos de espera antes de tentar de novo.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorBody'
          example:
            name: rate_limit_exceeded
            message: Rate limit exceeded. Please retry after 30 seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API do workspace, criada em Configurações > Chaves de API.

````

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