Reonic Links API

openapi: 3.2.0
info:
  title: Reonic REST Api v3 Links 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: Links
  description: Resolve a resource into a URL where it can be viewed in the Reonic web app.
paths:
  /links:
    get:
      summary: Resolve a deep link to a Portal URL
      description: 'Given a resource type and id, returns the Portal URL where that resource can be viewed. For `residentialProject` / `commercialProject`, the URL is resolved to the project''s current stage (request, offer, or installation); pass the stage-specific type instead to skip that resolution. The optional `subPath` selects a Portal sub-view (e.g. `basics`, `checklist`, `documents`); ignored for resource types that don''t have sub-views.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Links
      parameters:
      - schema:
          type: string
          enum:
          - residentialProject
          - residentialRequest
          - residentialOffer
          - residentialInstallation
          - commercialProject
          - commercialRequest
          - commercialOffer
          - commercialInstallation
          - contact
          - task
          - note
          - file
          - photogrammetryJob
        required: true
        name: type
        in: query
      - schema:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        required: true
        name: id
        in: query
      - schema:
          type: string
          minLength: 1
          maxLength: 100
        required: false
        name: subPath
        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: The full Portal URL for the resource
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                required:
                - url
      operationId: getLinks
      x-operation-id-source: derived
components:
  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