Reonic File Folders API

openapi: 3.2.0
info:
  title: Reonic REST Api v3 File Folders API
  description: The Reonic REST API v3 provides programmatic access to create and manage resources.
  version: 3.2.0
  contact:
    email: kontakt@reonic.de
    url: https://reonic.com
    name: Reonic GmbH
servers:
- url: '{apiBaseUrl}/rest/v3/'
security:
- X-Authorization: []
tags:
- name: File Folders
  description: 'Folders that organize **Files** within a project or contact.

    > [!note]

    > Personal and template folders are not exposed via the API.'
paths:
  /fileFolders:
    get:
      summary: List file folders
      description: 'List all file folders attached to an entity, such as a contact or residential project.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - File Folders
      parameters:
      - schema:
          type: string
          enum:
          - contact
          - residentialProject
          - commercialProject
          description: The type of the parent entity.
          example: residentialProject
        required: true
        description: The type of the parent entity.
        name: parentType
        in: query
      - schema:
          type: string
          format: uuid
          description: ID of the entity to list folders for.
          example: 123e4567-e89b-12d3-a456-426614174000
        required: true
        description: ID of the entity to list folders for.
        name: parentId
        in: query
      - schema:
          type: string
          example: no-cache
        required: false
        name: Reonic-Cache-Control
        in: header
        description: Set to 'no-cache' to bypass the 1-hour response cache and force a fresh read. The fresh response is then written back to the cache for subsequent callers. Forced refreshes count against the uncached rate-limit bucket (30/min); only cache hits count against the cached bucket (500/min).
      responses:
        '200':
          description: List of all file folders
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/FileFolder'
                    description: List of items
                required:
                - data
      operationId: getFileFolders
      x-operation-id-source: derived
  /fileFolders/{folderId}:
    get:
      summary: Get file folder
      description: 'Get a single file folder by its ID.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - File Folders
      parameters:
      - schema:
          type: string
          format: uuid
          description: ID of the file folder.
          example: 123e4567-e89b-12d3-a456-426614174000
        required: true
        description: ID of the file folder.
        name: folderId
        in: path
      - schema:
          type: string
          example: no-cache
        required: false
        name: Reonic-Cache-Control
        in: header
        description: Set to 'no-cache' to bypass the 1-hour response cache and force a fresh read. The fresh response is then written back to the cache for subsequent callers. Forced refreshes count against the uncached rate-limit bucket (30/min); only cache hits count against the cached bucket (500/min).
      responses:
        '200':
          description: File folder details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileFolder'
      operationId: getFileFoldersByFolderId
      x-operation-id-source: derived
components:
  schemas:
    FileFolder:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        parent:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: ID of the entity this folder belongs to.
              example: 123e4567-e89b-12d3-a456-426614174000
            type:
              type: string
              enum:
              - contact
              - residentialProject
              - commercialProject
              description: The type of the parent entity.
              example: residentialProject
          required:
          - id
          - type
        visibleInCustomerPortal:
          type: boolean
          description: Whether this folder is visible in the customer portal or not.
        createdAt:
          type: string
          format: date-time
          example: '2026-01-01T15:30:00.000Z'
        createdById:
          type:
          - string
          - 'null'
          format: uuid
          description: Reference to [**Users**](#tag/users)
          example: 123e4567-e89b-12d3-a456-426614174000
      required:
      - id
      - name
      - description
      - parent
      - visibleInCustomerPortal
      - createdAt
      - createdById
  securitySchemes:
    X-Authorization:
      type: apiKey
      in: header
      name: X-Authorization
x-tagGroups:
- name: People
  tags:
  - Contacts
  - Users
  - Teams
- name: Projects
  tags:
  - Residential Projects
  - Commercial Projects
- name: Working on a project
  tags:
  - Notes
  - Tasks
  - Files
  - File Folders
  - Activities
  - Time Tracking
  - Checklists
  - Checklist Templates
  - Signature Requests
- name: Calendar
  tags:
  - Calendars
  - Calendar Categories
  - Appointments
- name: Catalog
  tags:
  - Components
  - Planning Templates
  - Planning Packages
  - Offer Templates
- name: Workspace setup
  tags:
  - Kanban Boards
  - Kanban Columns
  - Tags
  - Lead Sources
- name: Wiki
  tags:
  - Wiki
- name: Services
  tags:
  - Photogrammetry
- name: API helpers
  tags:
  - Upload
  - Links
- name: Integrations
  tags:
  - Webhooks
- name: Guides
  tags:
  - Migrating from API v2 to v3
  - Changelog