Reonic Lead Sources API

openapi: 3.2.0
info:
  title: Reonic REST Api v3 Lead Sources 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: Lead Sources
  description: Channels that brought a customer/contact to your workspace, such as referrals, ad campaigns, or partner integrations. Used to attribute projects to their origin.
paths:
  /leadSources:
    get:
      summary: List lead sources
      description: 'List all lead sources.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Lead Sources
      parameters:
      - schema:
          type: string
          enum:
          - exclude
          - include
          - only
          default: exclude
          description: 'Controls whether archived lead sources appear in results. Default: exclude.'
        required: false
        description: 'Controls whether archived lead sources 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 lead sources
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LeadSource'
                    description: List of items
                required:
                - data
      operationId: getLeadSources
      x-operation-id-source: derived
  /leadSources/{leadSourceId}:
    get:
      summary: Get lead source
      description: 'Get a single lead source by its ID.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Lead Sources
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: leadSourceId
        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: Lead source details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeadSource'
      operationId: getLeadSourcesByLeadSourceId
      x-operation-id-source: derived
components:
  schemas:
    LeadSource:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
        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
      - name
      - 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