Reonic Signature Requests API

openapi: 3.2.0
info:
  title: Reonic REST Api v3 Signature Requests 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: Signature Requests
  description: Requests sent to a customer to sign a residential project's offer. Each carries the offer PDF for every variant the customer can choose between, available even before signing, plus the signed document once completed.
paths:
  /residentialProjects/{projectId}/signatureRequests:
    get:
      summary: List residential projects signature requests
      description: 'List all signature requests of a residential project, each including the offer PDF for every variant/payment option sent for signing. Signature requests are created once the project reaches the offer stage and its offer is sent out for signature.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Signature Requests
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: projectId
        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 project's signature requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResidentialProjectSignatureRequest'
                    description: List of items
                required:
                - data
      operationId: getResidentialProjectsByProjectIdSignatureRequests
      x-operation-id-source: derived
components:
  schemas:
    ResidentialProjectSignatureRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        projectId:
          type: string
          format: uuid
          description: Reference to [**Residential Projects**](#tag/residential-projects)
          example: 123e4567-e89b-12d3-a456-426614174000
        status:
          type: string
          enum:
          - awaitingSignature
          - signed
          - expired
          - withdrawn
          - revokedByCustomer
        offerDocuments:
          type: array
          items:
            type: object
            properties:
              variantId:
                type: string
                format: uuid
                description: The offer variant this document was generated for.
                example: 123e4567-e89b-12d3-a456-426614174000
              paymentOptionId:
                type:
                - string
                - 'null'
                format: uuid
                description: The payment option this document was generated for. `null` for legacy/default-payment documents.
                example: 123e4567-e89b-12d3-a456-426614174000
              pdfUrl:
                type: string
                format: uri
                description: This variant/payment option's offer PDF, as shown to the customer for signing. URL valid 24 hours.
            required:
            - variantId
            - paymentOptionId
            - pdfUrl
          description: Offer documents sent for signature, one per variant/payment option the customer can choose between.
        signedVariantId:
          type:
          - string
          - 'null'
          format: uuid
          description: The offer variant the customer signed. `null` until the request is signed.
          example: 123e4567-e89b-12d3-a456-426614174000
        signedPaymentOptionId:
          type:
          - string
          - 'null'
          format: uuid
          description: The payment option the customer signed. `null` until signed, or for legacy/default-payment documents.
          example: 123e4567-e89b-12d3-a456-426614174000
        signedPdfUrl:
          type:
          - string
          - 'null'
          format: uri
          description: Countersigned offer document; `null` until signed. After the customer revokes (`revokedByCustomer`), points to that document, stamped to reflect the revocation. URL valid 24 hours.
        revocationPdfUrl:
          type:
          - string
          - 'null'
          format: uri
          description: The customer's separate revocation declaration, if one was recorded. `null` otherwise — a revocation doesn't always include a separate declaration; the revoked contract itself is `signedPdfUrl`. URL valid 24 hours.
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type:
          - string
          - 'null'
          format: date-time
        signedAt:
          type:
          - string
          - 'null'
          format: date-time
        withdrawnAt:
          type:
          - string
          - 'null'
          format: date-time
          description: When your team withdrew a still-pending request (status `withdrawn`); `null` otherwise. For customer revocation of a signed contract, see `revokedByCustomerAt`.
        revokedByCustomerAt:
          type:
          - string
          - 'null'
          format: date-time
          description: When the customer revoked an already-signed contract (status `revokedByCustomer`); `null` otherwise.
      required:
      - id
      - projectId
      - status
      - offerDocuments
      - signedVariantId
      - signedPaymentOptionId
      - signedPdfUrl
      - revocationPdfUrl
      - createdAt
      - expiresAt
      - signedAt
      - withdrawnAt
      - revokedByCustomerAt
  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