Pre-configured combinations of planning packages used to quickly populate package categories when creating an offer. > [!warning] > **Beta:** These endpoints are in beta and may change as the service evolves. Please report issues or unexpected behavior to our team.
openapi: 3.1.0
info:
title: Reonic REST Api v3 Activities Offer 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: Offer Templates
description: "Pre-configured combinations of planning packages used to quickly populate package categories when creating an offer.\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: Offer Templates (BETA)
paths:
/offerTemplates:
get:
summary: List offer templates
description: 'List offer templates. An offer template is a pre-configured combination of planning packages used to quickly populate package categories when creating an offer.
**Allowed API keys:** Read-only, Read and Write'
tags:
- Offer Templates
x-badges:
- name: BETA
position: before
color: '#ea580c'
parameters:
- 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 offer templates
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OfferTemplate'
description: List of items
required:
- data
/offerTemplates/{offerTemplateId}:
get:
summary: Get offer template
description: 'Get a single offer template by its ID.
**Allowed API keys:** Read-only, Read and Write'
tags:
- Offer Templates
x-badges:
- name: BETA
position: before
color: '#ea580c'
parameters:
- schema:
type: string
format: uuid
required: true
name: offerTemplateId
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 offer template
content:
application/json:
schema:
$ref: '#/components/schemas/OfferTemplate'
/offerTemplates/create:
post:
summary: Create offer template
description: 'Create a new offer template. The template is created with a default name and no planning package references; use `POST /offerTemplates/{id}/update` to configure its package categories.
**Allowed API keys:** Read and Write'
tags:
- Offer 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 offer template
content:
application/json:
schema:
$ref: '#/components/schemas/OfferTemplate'
/offerTemplates/{offerTemplateId}/update:
post:
summary: Update offer template
description: 'Update an existing offer template.
**Allowed API keys:** Read and Write'
tags:
- Offer Templates
x-badges:
- name: BETA
position: before
color: '#ea580c'
parameters:
- schema:
type: string
format: uuid
required: true
name: offerTemplateId
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:
- residential
- commercial
solarPackageId:
type:
- string
- 'null'
format: uuid
batteryStoragePackageId:
type:
- string
- 'null'
format: uuid
evChargerPackageId:
type:
- string
- 'null'
format: uuid
heatPumpPackageId:
type:
- string
- 'null'
format: uuid
optionalPackageId:
type:
- string
- 'null'
format: uuid
additionalPackageId:
type:
- string
- 'null'
format: uuid
additionalProperties: false
responses:
'200':
description: The updated offer template
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/OfferTemplate'
required:
- data
/offerTemplates/{offerTemplateId}/delete:
post:
summary: Delete offer template
description: 'Delete an offer template by its ID.
**Allowed API keys:** Read and Write'
tags:
- Offer Templates
parameters:
- schema:
type: string
format: uuid
required: true
name: offerTemplateId
in: path
responses:
'200':
description: The deleted offer 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:
OfferTemplate:
type: object
properties:
id:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
name:
type: string
description:
type: string
position:
type: number
active:
type: boolean
targets:
type: array
items:
type: string
enum:
- residential
- commercial
solarPackageId:
type:
- string
- 'null'
format: uuid
batteryStoragePackageId:
type:
- string
- 'null'
format: uuid
evChargerPackageId:
type:
- string
- 'null'
format: uuid
heatPumpPackageId:
type:
- string
- 'null'
format: uuid
optionalPackageId:
type:
- string
- 'null'
format: uuid
additionalPackageId:
type:
- string
- 'null'
format: uuid
updatedAt:
type:
- string
- 'null'
format: date-time
example: '2026-01-01T15:30:00.000Z'
required:
- id
- name
- description
- position
- active
- targets
- solarPackageId
- batteryStoragePackageId
- evChargerPackageId
- heatPumpPackageId
- optionalPackageId
- additionalPackageId
- updatedAt
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