SoftSync AI Booking pages API

openapi: 3.2.0
info:
  title: Softsync Booking pages 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: Booking pages
paths:
  /public/meetings/{workspaceId}/{linkId}:
    get:
      operationId: PublicMeetingsController_getType
      parameters:
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      responses:
        '200':
          description: ''
      summary: Read the safe public meeting-type details
      tags:
      - Booking pages
      x-feature: meetings
  /public/meetings/{workspaceId}/{linkId}/slots:
    get:
      operationId: PublicMeetingsController_getSlots
      parameters:
      - name: from
        required: true
        in: query
        description: Start of the window, ISO 8601.
        schema:
          type: string
      - name: to
        required: true
        in: query
        description: End of the window, ISO 8601. At most 31 days after from.
        schema:
          type: string
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MeetingSlotDto'
      summary: List bookable public time slots
      tags:
      - Booking pages
      x-feature: meetings
  /public/meetings/{workspaceId}/{linkId}/sessions:
    get:
      operationId: PublicMeetingsController_getSessions
      parameters:
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      responses:
        '200':
          description: ''
      summary: List the upcoming sessions of an event meeting, with places left
      tags:
      - Booking pages
      x-feature: meetings
  /public/meetings/{workspaceId}/{linkId}/bookings:
    post:
      operationId: PublicMeetingsController_book
      parameters:
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicMeetingBookingDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeetingBookingDto'
      summary: Create an idempotent public booking
      tags:
      - Booking pages
      x-feature: meetings
  /public/meetings/{workspaceId}/{linkId}/sessions/{sessionId}/registrations:
    post:
      operationId: PublicMeetingsController_register
      parameters:
      - name: sessionId
        required: true
        in: path
        schema:
          type: string
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicMeetingBookingDto'
      responses:
        '201':
          description: ''
      summary: Register a guest for an event session
      tags:
      - Booking pages
      x-feature: meetings
  /public/meetings/{workspaceId}/{linkId}/sessions/{sessionId}/registrations/{attendeeId}:
    delete:
      operationId: PublicMeetingsController_cancelRegistration
      parameters:
      - name: sessionId
        required: true
        in: path
        schema:
          type: string
      - name: attendeeId
        required: true
        in: path
        schema:
          type: string
      - name: linkId
        required: true
        in: path
        description: Public link UUID
        schema:
          format: uuid
      - name: workspaceId
        required: true
        in: path
        description: Workspace UUID
        schema:
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelMeetingRegistrationDto'
      responses:
        '200':
          description: ''
      summary: Cancel an event registration with its cancellation token
      tags:
      - Booking pages
      x-feature: meetings
components:
  schemas:
    MeetingSlotDto:
      type: object
      properties:
        start:
          type: string
          description: When the meeting would start, ISO 8601
        end:
          type: string
          description: When it would end, ISO 8601
        hostCount:
          type: number
          description: How many hosts are free then
        sessionId:
          type: string
          description: 'Event meetings only: the session to register for'
        remainingSeats:
          type: number
          description: 'Event meetings only: places left'
      required:
      - start
      - end
      - hostCount
    MeetingBookingDto:
      type: object
      properties:
        id:
          type: string
        meetingTypeId:
          type: string
        bookingMode:
          allOf:
          - $ref: '#/components/schemas/MeetingKind'
        maxAttendees:
          type: number
        attendees:
          type: array
          items:
            $ref: '#/components/schemas/MeetingAttendeeDto'
        start:
          type: string
        end:
          type: string
        bookerName:
          type: string
        bookerEmail:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/MeetingBookingStatus'
        hostIds:
          type: array
          items:
            type: string
        organizerHostId:
          type: string
          description: The host whose calendar and mailbox hold this booking
        needsHost:
          type: boolean
          description: 'That host''s mailbox is gone: someone else must take it'
        meetingLink:
          type: string
        contactId:
          type: string
        companyId:
          type: string
        notes:
          type: string
        responses:
          type: object
          additionalProperties: true
      required:
      - id
      - meetingTypeId
      - start
      - end
      - bookerName
      - bookerEmail
      - status
      - hostIds
    CreatePublicMeetingBookingDto:
      type: object
      properties:
        guestEmails:
          description: Extra people to invite along (up to 10).
          type: array
          items:
            type: string
        start:
          type: string
          description: Start time, ISO 8601.
        timeZone:
          type: string
          description: The guest's IANA time zone, e.g. Europe/Oslo, used in their confirmation. Left out, the meeting's own time zone is used.
        formData:
          type: object
          description: Answers keyed by the booking form's field ids, from the form on the public meeting details.
          additionalProperties: true
        idempotencyKey:
          type: string
          description: A unique value you choose. Sending the same value again returns the first result instead of creating a duplicate.
      required:
      - start
      - idempotencyKey
    MeetingAttendeeStatus:
      type: string
      enum:
      - confirmed
      - cancelled
    MeetingBookingStatus:
      type: string
      enum:
      - confirmed
      - cancelled
      - failed
    MeetingKind:
      type: string
      enum:
      - appointment
      - event
    CancelMeetingRegistrationDto:
      type: object
      properties:
        cancellationToken:
          type: string
          description: The token returned when the guest registered.
      required:
      - cancellationToken
    MeetingAttendeeDto:
      type: object
      properties:
        id:
          type: string
        guestOf:
          type: string
          description: 'Invited by a booker or host: the booker''s id'
        name:
          type: string
        email:
          type: string
        status:
          allOf:
          - $ref: '#/components/schemas/MeetingAttendeeStatus'
        responses:
          type: object
          additionalProperties: true
        notes:
          type: string
      required:
      - id
      - name
      - email
      - status
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key