SoftSync AI Workspaces API

openapi: 3.2.0
info:
  title: Softsync Workspaces 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: Workspaces
paths:
  /workspaces/managed:
    get:
      operationId: getManagedWorkspaces
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedWorkspacesDto'
      summary: The client organizations this organization manages, and the one it is managed by
      tags:
      - Workspaces
      x-feature: workspace
    post:
      operationId: addManagedWorkspace
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddManagedWorkspaceDto'
      responses:
        '204':
          description: ''
      summary: Manage another organization from this one. You must be an admin of both
      tags:
      - Workspaces
      x-feature: workspace
  /workspaces/managed/enabled:
    put:
      operationId: setManagedWorkspacesEnabled
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetManagedEnabledDto'
      responses:
        '204':
          description: ''
      summary: Turn client organizations on or off for this organization
      tags:
      - Workspaces
      x-feature: workspace
  /workspaces/managed/{clientId}:
    delete:
      operationId: removeManagedWorkspace
      parameters:
      - name: clientId
        required: true
        in: path
        description: The client organization
        schema:
          type: string
      responses:
        '204':
          description: ''
      summary: Stop managing a client organization from this one
      tags:
      - Workspaces
      x-feature: workspace
  /workspaces/managed-by:
    delete:
      operationId: leaveManagingWorkspace
      parameters: []
      responses:
        '204':
          description: ''
      summary: Leave the organization this one is managed from
      tags:
      - Workspaces
      x-feature: workspace
  /workspaces/{id}/members:
    get:
      description: Lists everyone in the workspace with their role. The id must be the workspace the API key belongs to; any other id is refused with 403.
      operationId: getMembers
      parameters:
      - name: id
        required: true
        in: path
        description: Workspace ID (from GET /api-keys/info)
        schema: {}
      responses:
        '200':
          description: Members retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembersListDto'
      summary: Get all members of a workspace
      tags:
      - Workspaces
      x-feature: workspace
components:
  schemas:
    ManagedWorkspaceDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        avatarUrl:
          type: string
        role:
          description: Your role there; null when you are not a member, so you can’t open it.
          allOf:
          - $ref: '#/components/schemas/WorkspaceRole'
      required:
      - id
      - name
      - role
    AddManagedWorkspaceDto:
      type: object
      properties:
        workspaceId:
          type: string
          description: The organization to manage from this one.
      required:
      - workspaceId
    ManagingWorkspaceDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      required:
      - id
      - name
    ManagedWorkspacesDto:
      type: object
      properties:
        managedBy:
          description: The organization this one is managed from, if any.
          allOf:
          - $ref: '#/components/schemas/ManagingWorkspaceDto'
        clients:
          description: The client organizations this one manages.
          type: array
          items:
            $ref: '#/components/schemas/ManagedWorkspaceDto'
        limit:
          type: number
          description: How many client organizations it may have.
      required:
      - managedBy
      - clients
      - limit
    WorkspaceRole:
      type: string
      enum:
      - ADMIN
      - EDITOR
      - VIEWER
      - GUEST
      description: Roles that see it besides its managers
    WorkspaceMemberDto:
      type: object
      properties:
        id:
          type: string
        userId:
          type: string
        userEmail:
          type: string
        userFirstName:
          type: string
        userLastName:
          type: string
        userAvatarUrl:
          type: string
        role:
          allOf:
          - $ref: '#/components/schemas/WorkspaceRole'
        joinedAt:
          format: date-time
          type: string
        acceptedAt:
          format: date-time
          type: string
      required:
      - id
      - userId
      - userEmail
      - role
      - joinedAt
    SetManagedEnabledDto:
      type: object
      properties:
        'on':
          type: boolean
          description: Whether this organization can run client organizations.
      required:
      - 'on'
    MembersListDto:
      type: object
      properties:
        success:
          type: boolean
        members:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceMemberDto'
      required:
      - success
      - members
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key