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

# Obter o Caderno de um registro

> Devolve o [Caderno](https://docs.olie.ai/guides/notebook/overview) de um projeto, cliente, contato ou usuário, com a árvore de páginas em `threads`. Se o registro ainda não tem Caderno, ele é criado nesta chamada com uma *Página principal* vazia. Exige permissão de edição no registro. Aceita token de aplicação.



## OpenAPI

````yaml /api-reference/openapi.json get /api/management/forums
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/forums:
    get:
      tags:
        - forums
      summary: Obter o Caderno de um registro
      description: >-
        Devolve o [Caderno](https://docs.olie.ai/guides/notebook/overview) de um
        projeto, cliente, contato ou usuário, com a árvore de páginas em
        `threads`. Se o registro ainda não tem Caderno, ele é criado nesta
        chamada com uma *Página principal* vazia. Exige permissão de edição no
        registro. Aceita token de aplicação.
      parameters:
        - name: model_class
          in: query
          description: >-
            Tipo do registro: `App\Models\Project`, `App\Models\Customer`,
            `App\Models\Contact` ou `App\Models\FrameRelationship` (usuário).
          schema:
            type: string
          example: ''
        - name: model_id
          in: query
          description: ID do registro dono do Caderno.
          schema:
            type: string
          example: ''
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                description: Resposta com o Caderno.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `true` em caso de sucesso.
                  forum:
                    type: object
                    description: Caderno do registro.
                    properties:
                      id:
                        type: string
                        description: ID (UUID) do Caderno.
                        format: uuid
                      old_id:
                        type: integer
                        description: Uso interno da plataforma; pode ser ignorado.
                      frame_id:
                        type: string
                        description: ID (UUID) da empresa.
                        format: uuid
                      model_id:
                        type: string
                        description: ID do registro dono do Caderno.
                      model_class:
                        type: string
                        description: Tipo do registro dono do Caderno.
                      default_thread_id:
                        type: integer
                        description: ID da página principal do Caderno.
                      created_at:
                        type: string
                        description: Data de criação.
                        format: date-time
                      updated_at:
                        type: string
                        description: Data da última alteração.
                        format: date-time
                      deleted_at:
                        type: string
                        description: Data de remoção; `null` para Caderno ativo.
                        format: date-time
                      threads:
                        type: array
                        description: >-
                          Páginas da raiz, em ordem, cada uma com suas
                          subpáginas em `children`.
                        items:
                          description: Página do Caderno.
                          type: object
                          properties:
                            id:
                              type: integer
                              description: ID da página.
                            name:
                              type: string
                              description: Nome da página.
                            forum_id:
                              type: string
                              description: ID (UUID) do Caderno da página.
                              format: uuid
                            parent_id:
                              type: integer
                              description: >-
                                ID da página pai; `null` quando a página está na
                                raiz.
                            order:
                              type: integer
                              description: Posição da página entre as irmãs (crescente).
                            editor_type:
                              type: string
                              enum:
                                - tiptap
                                - editorjs
                              description: >-
                                Editor da página: `tiptap` (atual) ou `editorjs`
                                (anterior, somente leitura).
                            created_at:
                              type: string
                              description: Data de criação.
                              format: date-time
                            updated_at:
                              type: string
                              description: Data da última alteração dos dados da página.
                              format: date-time
                            deleted_at:
                              type: string
                              description: Data de remoção; `null` para página ativa.
                              format: date-time
                            cdn_migrated:
                              type: integer
                              description: Uso interno da plataforma; pode ser ignorado.
                            children:
                              type: array
                              description: >-
                                Subpáginas, no mesmo formato da página
                                (recursivo).
                              items:
                                description: >-
                                  Subpágina, com os mesmos campos da página e a
                                  lista `children`.
                                type: object
              example:
                response: true
                forum:
                  id: 3f6b2a1c-9d8e-4f7a-b6c5-d4e3f2a1b0c9
                  old_id: null
                  frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                  model_id: 8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
                  model_class: App\Models\Project
                  default_thread_id: 1201
                  created_at: '2026-11-03T13:10:00.000000Z'
                  updated_at: '2026-11-03T13:10:00.000000Z'
                  deleted_at: null
                  threads:
                    - id: 1201
                      name: Página principal
                      forum_id: 3f6b2a1c-9d8e-4f7a-b6c5-d4e3f2a1b0c9
                      parent_id: null
                      order: 0
                      editor_type: tiptap
                      created_at: '2026-11-03T13:10:00.000000Z'
                      updated_at: '2026-11-03T13:10:00.000000Z'
                      deleted_at: null
                      cdn_migrated: 0
                      children: []
                    - id: 1202
                      name: Escopo e entregas
                      forum_id: 3f6b2a1c-9d8e-4f7a-b6c5-d4e3f2a1b0c9
                      parent_id: null
                      order: 1
                      editor_type: tiptap
                      created_at: '2026-11-03T13:10:00.000000Z'
                      updated_at: '2026-11-03T13:10:00.000000Z'
                      deleted_at: null
                      cdn_migrated: 0
                      children:
                        - id: 1203
                          name: Wireframes aprovados
                          forum_id: 3f6b2a1c-9d8e-4f7a-b6c5-d4e3f2a1b0c9
                          parent_id: 1202
                          order: 0
                          editor_type: tiptap
                          created_at: '2026-11-03T13:10:00.000000Z'
                          updated_at: '2026-11-03T13:10:00.000000Z'
                          deleted_at: null
                          cdn_migrated: 0
                          children: []
        '403':
          description: Sem permissão
          content:
            application/json:
              schema:
                description: Resposta de erro.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
                  permission:
                    type: string
                    description: Permissão que faltou ao usuário.
              example:
                response: false
                message: permission_required
                error: An permission is required to that action
                permission: projects.edit.8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
        '404':
          description: Registro de outra empresa
          content:
            application/json:
              schema:
                type: object
                description: Resposta de erro.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
              example:
                response: false
                message: project_model_not_found
                error: >-
                  No query results for model [App\Models\Project]
                  8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
        '422':
          description: Validação falhou
          content:
            application/json:
              schema:
                type: object
                description: Resposta de erro.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
                  validation:
                    type: object
                    description: >-
                      Erros por campo: cada chave é um campo e o valor, a lista
                      de mensagens.
                    additionalProperties:
                      type: array
                      description: Mensagens de erro do campo.
                      items:
                        type: string
                        description: Mensagem de erro.
              example:
                response: false
                message: validation_errors
                error: O campo model id é obrigatório.
                validation:
                  model_id:
                    - O campo model id é obrigatório.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

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