Reonic Checklist Templates API

openapi: 3.1.0
info:
  title: Reonic REST Api v3 Activities Checklist Templates API
  description: 'The Reonic REST API v3 provides programmatic access to create and manage resources. The API follows REST principles and returns responses in JSON format. Authentication is required via an API key passed in the X-Authorization header.


    ## Errors


    All endpoints return errors with the same JSON shape:


    ```json

    { "message": "human-readable description" }

    ```


    `400` responses additionally include an `errors` field with per-field validation details.


    The HTTP status code identifies the cause:


    | Status  | Meaning | When |

    |--------|---------|------|

    | `400` | Bad Request | Path params, query string, or request body failed validation. Inspect `errors` for the field-level breakdown. |

    | `401` | Unauthorized | The `X-Authorization` header is missing, malformed, does not match an active API key, or belongs to a different API version. The response never indicates which check failed; check that the key matches the endpoint version. API v3 endpoints require a v3 key with the `rnc_v3_` prefix. |

    | `403` | Forbidden | The API key is read-only and the request targeted a write endpoint (`POST`). Issue a key with write access. |

    | `404` | Not Found | A resource referenced by a path id does not exist or is not visible to your workspace. |

    | `429` | Too Many Requests | The per-client rate limit was exceeded. See **Rate limiting** below. |

    | `500` | Internal Server Error | Unexpected failure. Safe to retry once; if it persists, contact support. |

    | `503` | Service Unavailable | A backing dependency is temporarily unavailable. Retry with exponential backoff. |


    ## Rate limiting


    Limits are shared across all API keys you hold and reset on a 1-minute window. Two buckets:


    | Bucket | Limit | Applies to |

    |--------|-------|------------|

    | `cached` | 500 / min | `GET` requests served from the response cache |

    | `uncached` | 30 / min | Cache misses, `GET` requests sent with `Reonic-Cache-Control: no-cache`, and all `POST` requests |


    Every response includes:


    - `X-RateLimit-Bucket` — `cached` or `uncached`

    - `X-RateLimit-Limit` — the bucket''s ceiling (`500` or `30`)

    - `X-RateLimit-Remaining` — calls left in the current window

    - `X-RateLimit-Reset` — Unix epoch seconds at which the window resets

    - `X-RateLimit-Policy` — `<limit>;w=60`


    `429` responses additionally set `Retry-After` (in seconds). Wait at least that long before retrying.


    ## Caching and Reonic-Cache-Control


    `GET` responses are cached for up to 1 hour. Identical requests (same path and query) on the same API key return the cached result. To force a fresh read, send `Reonic-Cache-Control: no-cache`; the response is then refreshed and re-cached. Forced refreshes count against the `uncached` rate-limit bucket.


    The standard `Cache-Control` header is not honored. Use `Reonic-Cache-Control` to control caching behavior.


    ## Authentication


    Every request must include your API key in the `X-Authorization` header:


    ```

    X-Authorization: <your-api-key>

    ```


    API keys are issued from the Reonic web app and look like `rnc_v3_…`. Send the full value, including the prefix.

    '
  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: Checklist Templates
  description: "Reusable checklists. Apply one to a residential project to populate its [**Checklists**](#tag/checklists).\n\n> [!warning] \n> **Beta:** These endpoints are in beta and may change as the service evolves. Please report issues or unexpected behavior to our team."
  x-displayName: Checklist Templates (BETA)
paths:
  /checklistTemplates:
    get:
      summary: List checklist templates
      description: 'List checklist templates (planning templates). A checklist template is a reusable bundle of line items that can be applied to a residential or commercial offer at a given stage. Distinct from `/checklists/{projectId}`, which returns the per-project checklist state.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Checklist Templates
      x-badges:
      - name: BETA
        position: before
        color: '#ea580c'
      parameters:
      - schema:
          type: array
          items:
            type: string
            enum:
            - all
            - residential
            - residentialSolar
            - residentialEvCharger
            - residentialBatteryStorage
            - residentialHotWaterStorage
            - residentialHeatingStorage
            - residentialHeating
            - residentialHeatPump
            - residentialAccessoryToHeatPump
            - residentialOptionalComponents
            - residentialAdditionalComponents
            - commercial
            - commercialSolar
            - commercialBatteryStorage
            - commercialLandlordToTenant
            - commercialPowerPurchaseAgreement
            - commercialAdditionalComponents
          description: 'Comma-separated list or repeated query param. Allowed values: all, residential, residentialSolar, residentialEvCharger, residentialBatteryStorage, residentialHotWaterStorage, residentialHeatingStorage, residentialHeating, residentialHeatPump, residentialAccessoryToHeatPump, residentialOptionalComponents, residentialAdditionalComponents, commercial, commercialSolar, commercialBatteryStorage, commercialLandlordToTenant, commercialPowerPurchaseAgreement, commercialAdditionalComponents.'
        required: false
        description: 'Comma-separated list or repeated query param. Allowed values: all, residential, residentialSolar, residentialEvCharger, residentialBatteryStorage, residentialHotWaterStorage, residentialHeatingStorage, residentialHeating, residentialHeatPump, residentialAccessoryToHeatPump, residentialOptionalComponents, residentialAdditionalComponents, commercial, commercialSolar, commercialBatteryStorage, commercialLandlordToTenant, commercialPowerPurchaseAgreement, commercialAdditionalComponents.'
        style: form
        explode: false
        name: target
        in: query
      - schema:
          type:
          - boolean
          - 'null'
        required: false
        name: active
        in: query
      - schema:
          type:
          - boolean
          - 'null'
        required: false
        name: includeAny
        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: Array of checklist templates
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChecklistTemplate'
                    description: List of items
                required:
                - data
  /checklistTemplates/{checklistId}:
    get:
      summary: Get checklist template
      description: 'Get a single checklist template by its ID.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Checklist Templates
      x-badges:
      - name: BETA
        position: before
        color: '#ea580c'
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: checklistId
        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: The checklist template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecklistTemplate'
  /checklistTemplates/create:
    post:
      summary: Create checklist template
      description: 'Create a new checklist template. The template is created with a default name, no items, and no targets; use `POST /checklistTemplates/{id}/update` to populate it.


        **Allowed API keys:** Read and Write'
      tags:
      - Checklist Templates
      x-badges:
      - name: BETA
        position: before
        color: '#ea580c'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
              additionalProperties: false
      responses:
        '201':
          description: The newly created checklist template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChecklistTemplate'
  /checklistTemplates/{checklistId}/update:
    post:
      summary: Update checklist template
      description: 'Update an existing checklist template''s metadata. The `targets` array must always be supplied — passing an empty array clears the targeting. Item editing is not currently exposed on V3.


        **Allowed API keys:** Read and Write'
      tags:
      - Checklist Templates
      x-badges:
      - name: BETA
        position: before
        color: '#ea580c'
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: checklistId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                description:
                  type: string
                  maxLength: 2000
                active:
                  type: boolean
                targets:
                  type: array
                  items:
                    type: string
                    enum:
                    - all
                    - residential
                    - residentialSolar
                    - residentialEvCharger
                    - residentialBatteryStorage
                    - residentialHotWaterStorage
                    - residentialHeatingStorage
                    - residentialHeating
                    - residentialHeatPump
                    - residentialAccessoryToHeatPump
                    - residentialOptionalComponents
                    - residentialAdditionalComponents
                    - commercial
                    - commercialSolar
                    - commercialBatteryStorage
                    - commercialLandlordToTenant
                    - commercialPowerPurchaseAgreement
                    - commercialAdditionalComponents
              required:
              - targets
              additionalProperties: false
      responses:
        '200':
          description: The updated checklist template
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ChecklistTemplate'
                required:
                - data
  /checklistTemplates/{checklistId}/delete:
    post:
      summary: Delete checklist template
      description: 'Delete a checklist template by its ID.


        **Allowed API keys:** Read and Write'
      tags:
      - Checklist Templates
      x-badges:
      - name: BETA
        position: before
        color: '#ea580c'
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: checklistId
        in: path
      responses:
        '200':
          description: The deleted checklist template ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 123e4567-e89b-12d3-a456-426614174000
                    required:
                    - id
                required:
                - data
components:
  schemas:
    ChecklistTemplate:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        active:
          type: boolean
        position:
          type: number
        targets:
          type: array
          items:
            type: string
            enum:
            - all
            - residential
            - residentialSolar
            - residentialEvCharger
            - residentialBatteryStorage
            - residentialHotWaterStorage
            - residentialHeatingStorage
            - residentialHeating
            - residentialHeatPump
            - residentialAccessoryToHeatPump
            - residentialOptionalComponents
            - residentialAdditionalComponents
            - commercial
            - commercialSolar
            - commercialBatteryStorage
            - commercialLandlordToTenant
            - commercialPowerPurchaseAgreement
            - commercialAdditionalComponents
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              componentId:
                type: string
                format: uuid
              quantity:
                type: number
              position:
                type: number
              visibleToCustomer:
                type: boolean
              priceOverridesComponent:
                type: boolean
            required:
            - id
            - componentId
            - quantity
            - position
            - visibleToCustomer
            - priceOverridesComponent
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-01-01T15:30:00.000Z'
        createdById:
          type:
          - string
          - 'null'
          format: uuid
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-01-01T15:30:00.000Z'
        updatedById:
          type:
          - string
          - 'null'
          format: uuid
      required:
      - id
      - name
      - description
      - active
      - position
      - targets
      - items
      - createdAt
      - createdById
      - updatedAt
      - updatedById
  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