> ## 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 pastas do Pinterest

> Lista as pastas de uma conta do Pinterest, lidas na hora no Pinterest. Use o `id` de uma pasta como `platforms[].meta.board_id` num destino do Pinterest. `truncated` vem `true` quando o PostClean não conseguiu ler todas as páginas de pastas do Pinterest. Este endpoint também conta para um limite de 60 requisições por minuto por usuário, compartilhado com os outros endpoints de consulta de Pinterest, Discord e TikTok desta API e com algumas consultas que o mesmo usuário faz no app do PostClean (canais e menções do Discord, retorno das integrações com Google e Canva).



## OpenAPI

````yaml /openapi.json get /social-accounts/{account}/boards
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:
  /social-accounts/{account}/boards:
    parameters:
      - $ref: '#/components/parameters/AccountId'
    get:
      tags:
        - Social accounts
      summary: Listar pastas do Pinterest
      description: >-
        Lista as pastas de uma conta do Pinterest, lidas na hora no Pinterest.
        Use o `id` de uma pasta como `platforms[].meta.board_id` num destino do
        Pinterest. `truncated` vem `true` quando o PostClean não conseguiu ler
        todas as páginas de pastas do Pinterest. Este endpoint também conta para
        um limite de 60 requisições por minuto por usuário, compartilhado com os
        outros endpoints de consulta de Pinterest, Discord e TikTok desta API e
        com algumas consultas que o mesmo usuário faz no app do PostClean
        (canais e menções do Discord, retorno das integrações com Google e
        Canva).
      operationId: listPinterestBoards
      responses:
        '200':
          description: As pastas da conta.
          content:
            application/json:
              schema:
                type: object
                properties:
                  boards:
                    type: array
                    items:
                      $ref: '#/components/schemas/PinterestBoard'
                  truncated:
                    type: boolean
              example:
                boards:
                  - id: '1029854735246987654'
                    name: Product updates
                    cover_url: https://i.pinimg.com/400x300/ab/cd/ef/abcdef.jpg
                truncated: false
        '401':
          description: >-
            Chave de API ausente ou inválida, ou a conexão com o Pinterest
            expirou (corpo: a mensagem do Pinterest, ou `Access token has
            expired or been revoked`). Reconecte a conta no app.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              examples:
                invalid_key:
                  summary: Chave de API inválida
                  value:
                    message: Token not found.
                pinterest_expired:
                  summary: Conexão com o Pinterest expirada
                  value:
                    message: Access token has expired or been revoked
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          description: >-
            O Pinterest recusou a requisição (falta de permissão), ou a chave de
            API não pode ser usada (veja o 403 geral).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: A conta não é do Pinterest.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                message: Boards are only available for Pinterest accounts.
        '429':
          description: >-
            Nosso limite de requisições foi excedido (corpo
            `rate_limit_exceeded`, com `Retry-After`), ou o Pinterest informou
            um limite (corpo `{message}`, sem `Retry-After`).
          headers:
            Retry-After:
              description: >-
                Segundos de espera antes de tentar de novo. Só no nosso próprio
                limite.
              schema:
                type: integer
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/RateLimitErrorBody'
                  - $ref: '#/components/schemas/ErrorBody'
        '500':
          description: >-
            Não foi possível falar com o Pinterest (tempo esgotado), ou outra
            renovação de token desta conta estava em andamento.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
              example:
                message: Server Error
        '502':
          description: O Pinterest respondeu com um erro.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
components:
  parameters:
    AccountId:
      name: account
      in: path
      required: true
      description: Id da conta social (canal). Uma conta de outro workspace devolve `404`.
      schema:
        type: string
        format: uuid
      example: 9c8b7a65-4d3e-4f2a-8b1c-0d9e8f7a6b54
  schemas:
    PinterestBoard:
      type: object
      properties:
        id:
          type: string
          description: >-
            Id da pasta no Pinterest. Envie como `platforms[].meta.board_id` num
            destino do Pinterest.
        name:
          type: string
          description: Nome da pasta.
        cover_url:
          type:
            - string
            - 'null'
          description: Imagem de capa da pasta, quando o Pinterest tem uma.
    ErrorBody:
      type: object
      properties:
        message:
          type: string
      description: Corpo de erro com uma mensagem.
    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.
  responses:
    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.
    NotFound:
      description: O recurso não existe neste workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
  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.