SoftSync AI Calendar API

openapi: 3.2.0
info:
  title: Softsync Calendar 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: Calendar
paths:
  /plugins/mailbox/calendars:
    get:
      operationId: listCalendars
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: integrationId
        required: true
        in: query
        description: Integration ID
        schema:
          type: string
      - name: purpose
        required: false
        in: query
        description: Whether calendars are being listed for event writes or conflict checks
        schema:
          type: string
          enum:
          - write
          - conflict-check
      responses:
        '200':
          description: Calendars fetched successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MailboxCalendarDto'
      security:
      - bearer: []
      summary: List the calendars of one of your connected mailboxes
      tags:
      - Calendar
      x-feature: calendar
  /plugins/mailbox/calendar/event:
    post:
      operationId: createCalendarEvent
      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/CreateCalendarEventDto'
      responses:
        '201':
          description: Calendar event created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEventDto'
      security:
      - bearer: []
      summary: Create calendar event
      tags:
      - Calendar
      x-feature: calendar
  /plugins/mailbox/calendar/event/{eventId}:
    put:
      operationId: updateCalendarEvent
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: eventId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCalendarEventDto'
      responses:
        '200':
          description: Calendar event updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEventDto'
      security:
      - bearer: []
      summary: Update calendar event
      tags:
      - Calendar
      x-feature: calendar
    delete:
      operationId: cancelCalendarEvent
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: eventId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCalendarEventDto'
      responses:
        '200':
          description: Calendar event cancelled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarEventCancelledDto'
      security:
      - bearer: []
      summary: Cancel calendar event
      tags:
      - Calendar
      x-feature: calendar
components:
  schemas:
    CalendarConferenceInputDto:
      type: object
      properties:
        provider:
          type: string
          description: Conference provider
        url:
          type: string
          description: Conference URL
    CreateCalendarEventDto:
      type: object
      properties:
        integrationId:
          type: string
          description: Integration ID
        calendarId:
          type: string
          description: Calendar ID
        title:
          type: string
          description: Event title
        body:
          type: string
          description: Event body/description
        location:
          type: string
          description: Event location
        start:
          description: Start date and time
          allOf:
          - $ref: '#/components/schemas/CalendarDateTimeInputDto'
        end:
          description: End date and time
          allOf:
          - $ref: '#/components/schemas/CalendarDateTimeInputDto'
        conference:
          description: Conference details
          allOf:
          - $ref: '#/components/schemas/CalendarConferenceInputDto'
        attendees:
          description: List of attendees
          type: array
          items:
            $ref: '#/components/schemas/CalendarAttendeeInputDto'
      required:
      - integrationId
      - title
      - start
      - end
    DeleteCalendarEventDto:
      type: object
      properties:
        integrationId:
          type: string
          description: Integration ID
        calendarId:
          type: string
          description: Calendar ID
    MailboxCalendarDto:
      type: object
      properties:
        id:
          type: string
          description: Provider calendar identifier
        name:
          type: string
          description: Calendar display name
        color:
          type: string
          description: Calendar color
        canEdit:
          type: boolean
          description: Whether current user can edit
        isPrimary:
          type: boolean
          description: Whether this is the primary calendar
        timeZone:
          type: string
          description: Calendar timezone
      required:
      - id
      - name
    CalendarEventCancelledDto:
      type: object
      properties:
        success:
          type: boolean
          example: true
      required:
      - success
    UpdateCalendarEventDto:
      type: object
      properties:
        integrationId:
          type: string
          description: Integration ID
        calendarId:
          type: string
          description: Calendar ID
        title:
          type: string
          description: Event title
        body:
          type: string
          description: Event body/description
        location:
          type: string
          description: Event location
        start:
          description: Start date and time
          allOf:
          - $ref: '#/components/schemas/CalendarDateTimeInputDto'
        end:
          description: End date and time
          allOf:
          - $ref: '#/components/schemas/CalendarDateTimeInputDto'
        conference:
          description: Conference details
          allOf:
          - $ref: '#/components/schemas/CalendarConferenceInputDto'
        attendees:
          description: List of attendees
          type: array
          items:
            $ref: '#/components/schemas/CalendarAttendeeInputDto'
    CalendarDateTimeInputDto:
      type: object
      properties:
        date_time:
          type: string
          description: Date and time in ISO format
        time_zone:
          type: string
          description: Time zone identifier
      required:
      - date_time
    CalendarEventDto:
      type: object
      properties:
        id:
          type: string
          description: The calendar provider's event id
        title:
          type: string
          description: Event title
        start:
          type: string
          description: Start, ISO 8601
        end:
          type: string
          description: End, ISO 8601
        startTimeZone:
          type: string
          description: Time zone of the start
        endTimeZone:
          type: string
          description: Time zone of the end
        attendees:
          description: Attendee email addresses
          type: array
          items:
            type: string
        organizer:
          type: string
          description: Organizer email address
        meetingLink:
          type: string
          description: Video call link, when the event has one
        description:
          type: string
          description: Event description
        location:
          type: string
          description: Event location
        isCancelled:
          type: boolean
          description: True when the event is cancelled
      required:
      - id
      - title
      - start
      - end
      - attendees
    CalendarAttendeeInputDto:
      type: object
      properties:
        email:
          type: string
          description: Email address of the attendee
        display_name:
          type: string
          description: Display name of the attendee
      required:
      - email
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key