SoftSync AI Reminders API

openapi: 3.2.0
info:
  title: Softsync Reminders API
  description: '## Introduction


    The Softsync Platform API


    This API lets you read and write your Softsync data from your own applications. Authenticate with a personal API key created in **Settings → API Keys**, sent as the `x-api-key` header.


    **New here?** Read **Concepts** first, then **Authentication**, then **Quickstart: full cycle** — it walks the whole thing end to end. **Objects**, **Records**, **Groups & Views** and **Notes** cover each area in depth, and **Code Generation** shows how to turn this document into a typed client.


    To try a request from this page, paste your API key into the **Authentication** panel on the right.


    ## Support


    If you need help with API access or integration details, contact contact@softsync.ai.'
  version: 0.1.0
  contact: {}
servers: []
security:
- x-api-key: []
tags:
- name: Reminders
paths:
  /reminders:
    get:
      description: Reminders you can see, both one-time and repeating. Cancelled ones are omitted; completed ones only when asked for.
      operationId: listReminders
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: recordId
        required: true
        in: query
        schema:
          type: string
      - name: includeCompleted
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReminderListDto'
      security:
      - bearer: []
      summary: List reminders
      tags:
      - Reminders
      x-feature: reminders
    post:
      description: Give `dueAt` for a one-time reminder, or `cadence` plus `time` for a repeating one.
      operationId: createReminder
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReminderDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReminderDto'
      security:
      - bearer: []
      summary: Create a reminder
      tags:
      - Reminders
      x-feature: reminders
  /reminders/{reminderId}:
    patch:
      description: Reschedule or rename a one-time reminder, or pause and resume a repeating one. Rescheduling replaces the pending run and returns the new id.
      operationId: updateReminder
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: reminderId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReminderDto'
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Update a reminder
      tags:
      - Reminders
      x-feature: reminders
    delete:
      description: A one-time reminder is cancelled; a repeating one is removed. Neither fires again.
      operationId: deleteReminder
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: reminderId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Cancel a reminder
      tags:
      - Reminders
      x-feature: reminders
  /reminders/{reminderId}/complete:
    post:
      description: Marks a one-time reminder completed and keeps it available in reminder history.
      operationId: completeReminder
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: reminderId
        required: true
        in: path
        schema:
          type: string
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: Complete a one-time reminder
      tags:
      - Reminders
      x-feature: reminders
components:
  schemas:
    CreateReminderDto:
      type: object
      properties:
        title:
          type: string
          description: What the reminder says when it arrives.
        dueAt:
          type: string
          description: When a one-time reminder fires, as an ISO 8601 instant. Omit for a repeating reminder.
        cadence:
          description: How often a repeating reminder fires.
          allOf:
          - $ref: '#/components/schemas/ReminderCadence'
        time:
          type: string
          description: Local time a repeating reminder fires, as HH:MM.
        weekday:
          type: number
          description: 0 = Sunday through 6 = Saturday.
        monthDay:
          type: number
          description: Day of the month, for a monthly reminder.
        timezone:
          type: string
          description: IANA timezone the schedule is expressed in.
        visibility:
          description: 'private: only you are notified. public: every member of the workspace is.'
          allOf:
          - $ref: '#/components/schemas/ReminderVisibility'
        recipientUserIds:
          description: Selected workspace members to notify. Supplying this makes the audience selected, rather than private or public.
          type: array
          items:
            type: string
        recordId:
          type: string
          description: Record this reminder is about.
        recordTableId:
          type: string
          description: Table the linked record belongs to.
        recordLabel:
          type: string
          description: How the linked record reads in the reminder list.
      required:
      - title
    UpdateReminderDto:
      type: object
      properties:
        title:
          type: string
          description: New reminder text.
        cadence:
          description: New cadence for a repeating reminder, edited in place.
          allOf:
          - $ref: '#/components/schemas/ReminderCadence'
        time:
          type: string
          description: New local time, as HH:MM.
        weekday:
          type: number
        monthDay:
          type: number
        timezone:
          type: string
        visibility:
          allOf:
          - $ref: '#/components/schemas/ReminderVisibility'
        recipientUserIds:
          type: array
          items:
            type: string
        recordId:
          type: string
        recordTableId:
          type: string
        recordLabel:
          type: string
        dueAt:
          type: string
          description: New time for a one-time reminder.
        enabled:
          type: boolean
          description: Pause or resume a repeating reminder.
    ReminderStatus:
      type: string
      enum:
      - scheduled
      - overdue
      - completed
      - paused
      - failed
    ReminderCadence:
      type: string
      enum:
      - daily
      - weekly
      - monthly
    ReminderVisibility:
      type: string
      enum:
      - private
      - public
      - selected
    ReminderDto:
      type: object
      properties:
        id:
          type: string
          description: Run id for a one-time reminder, workflow name for a repeating one.
        kind:
          allOf:
          - $ref: '#/components/schemas/ReminderKind'
        title:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/ReminderStatus'
        visibility:
          allOf:
          - $ref: '#/components/schemas/ReminderVisibility'
        owner:
          type: string
          description: User id of whoever created it.
        recipientUserIds:
          description: Who gets notified.
          type: array
          items:
            type: string
        dueAt:
          type: string
        cadence:
          allOf:
          - $ref: '#/components/schemas/ReminderCadence'
        cron:
          type: string
        scheduleLabel:
          type: string
        timezone:
          type: string
        recordId:
          type: string
        recordTableId:
          type: string
        recordLabel:
          type: string
        enabled:
          type: boolean
        workflowVersion:
          type: string
        createdAt:
          type: string
          description: When the reminder was created.
        completedAt:
          type: string
          description: When the one-time reminder was completed.
      required:
      - id
      - kind
      - title
      - status
    ReminderKind:
      type: string
      enum:
      - once
      - recurring
    ReminderListDto:
      type: object
      properties:
        reminders:
          type: array
          items:
            $ref: '#/components/schemas/ReminderDto'
        count:
          type: number
      required:
      - reminders
      - count
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key