Reonic Tags API

openapi: 3.1.0
info:
  title: Reonic REST Api v3 Activities Tags 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: Tags
  description: Reusable labels for categorizing and filtering projects, contacts, and other entities.
paths:
  /tags:
    get:
      summary: List tags
      description: 'List all tags.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Tags
      parameters:
      - schema:
          type: string
          enum:
          - residentialProject
          - commercialProject
          description: Type of entity the tag can be applied to.
          example: residentialProject
        required: false
        description: Type of entity the tag can be applied to.
        name: parentType
        in: query
      - schema:
          type: string
          enum:
          - exclude
          - include
          - only
          default: exclude
          description: 'Controls whether archived tags appear in results. Default: exclude.'
        required: false
        description: 'Controls whether archived tags appear in results. Default: exclude.'
        name: archived
        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 tags
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Tag'
                    description: List of items
                required:
                - data
  /tags/{tagId}:
    get:
      summary: Get tag
      description: 'Get a single tag by its ID.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Tags
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: tagId
        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: Tag details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
        '404':
          description: Tag not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not found
                required:
                - message
  /tags/create:
    post:
      summary: Create tag
      description: 'Create a new tag


        **Allowed API keys:** Read and Write'
      tags:
      - Tags
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  minLength: 1
                  maxLength: 500
                parentType:
                  type: string
                  enum:
                  - residentialProject
                  - commercialProject
                  description: Type of entity the tag can be applied to.
                  example: residentialProject
                textColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Hex code of the tag's text color
                  example: '#000000'
                backgroundColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Hex code of the tag's background color
                  example: '#00FF00'
              required:
              - label
              - parentType
              - textColor
              - backgroundColor
              additionalProperties: false
      responses:
        '201':
          description: The created tag
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
  /tags/{tagId}/update:
    post:
      summary: Update tag
      description: 'Update a tag by its ID.


        **Allowed API keys:** Read and Write'
      tags:
      - Tags
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: tagId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: string
                  minLength: 1
                  maxLength: 500
                textColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Hex code of the tag's text color
                  example: '#000000'
                backgroundColor:
                  type: string
                  pattern: ^#[0-9a-fA-F]{6}$
                  description: Hex code of the tag's background color
                  example: '#00FF00'
                archived:
                  type: boolean
                  description: '`true` to archive the tag, `false` to unarchive.'
              additionalProperties: false
      responses:
        '200':
          description: Updated tag
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Tag'
                required:
                - data
components:
  schemas:
    Tag:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        label:
          type: string
        parentType:
          type: string
          enum:
          - residentialProject
          - commercialProject
          description: Type of entity the tag can be applied to.
          example: residentialProject
        textColor:
          type: string
          description: Hex code of the tag's text color
          example: '#000000'
        backgroundColor:
          type: string
          description: Hex code of the tag's background color
          example: '#00FF00'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
          description: Last edited date
        archivedAt:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
      - label
      - parentType
      - textColor
      - backgroundColor
      - createdAt
      - updatedAt
      - archivedAt
  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