SoftSync AI

SoftSync AI Portals API

The Portals API from SoftSync AI — 5 operation(s) for portals.

GitHub OpenAPI

Operations 8

GET /portals List portals (admins) #
POST /portals Create a portal (admins) #
GET /portals/page-kinds Kinds of portal page and the feature each needs #
GET /portals/{id} Read a portal (admins) #
PUT /portals/{id} Save a portal (admins) #
DELETE /portals/{id} Move a portal to the bin #
POST /portals/{id}/invite Email a portal's link (admins) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/softsync-ai/openapi/softsync-ai-portals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-enrich-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-query-messages-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-update-meeting-type-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-semantic-search-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-create-meeting-type-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/softsync-ai/json-schema/softsync-ai-message-link-stats-query-dto-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/softsync-ai:softsync-ai-portals-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

softsync-ai-portals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Softsync Portals 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: Portals
paths:
  /portals:
    get:
      operationId: listPortals
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Portal'
      security:
      - bearer: []
      summary: List portals (admins)
      tags:
      - Portals
      x-feature: portals
    post:
      operationId: createPortal
      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/PortalDefinition'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portal'
      security:
      - bearer: []
      summary: Create a portal (admins)
      tags:
      - Portals
      x-feature: portals
  /portals/page-kinds:
    get:
      operationId: listPortalPageKinds
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PortalPageKindInfo'
      security:
      - bearer: []
      summary: Kinds of portal page and the feature each needs
      tags:
      - Portals
      x-feature: portals
  /portals/{id}:
    get:
      operationId: getPortal
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portal'
      security:
      - bearer: []
      summary: Read a portal (admins)
      tags:
      - Portals
      x-feature: portals
    put:
      operationId: updatePortal
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortalDefinition'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portal'
      security:
      - bearer: []
      summary: Save a portal (admins)
      tags:
      - Portals
      x-feature: portals
    delete:
      operationId: deletePortal
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - bearer: []
      summary: Move a portal to the bin
      tags:
      - Portals
      x-feature: portals
  /portals/{id}/invite:
    post:
      operationId: invitePortal
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                contactIds:
                  type: array
                  items:
                    type: string
                  description: Records on the sign-in list to send to (portals with sign-in).
                emails:
                  type: array
                  items:
                    type: string
                  description: Addresses to send to (portals without sign-in).
                note:
                  type: string
                  maxLength: 1000
                  description: A personal line added to the message.
                via:
                  type: string
                  enum:
                  - email
                  - sms
                  default: email
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      summary: Email a portal's link (admins)
      tags:
      - Portals
      x-feature: portals
  /portals/{id}/link:
    post:
      operationId: renewPortalLink
      parameters:
      - name: x-workspace-id
        in: header
        description: Workspace ID
        required: true
        schema:
          type: string
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Portal'
      security:
      - bearer: []
      summary: Give a portal a new link; the old link and its sign-ins stop working
      tags:
      - Portals
      x-feature: portals
components:
  schemas:
    PortalPageKind:
      type: string
      enum:
      - records
      - form
      - booking
    PortalPageKindInfo:
      type: object
      properties:
        kind:
          $ref: '#/components/schemas/PortalPageKind'
        feature:
          allOf:
          - $ref: '#/components/schemas/RegistryFeatureKey'
      required:
      - kind
      additionalProperties: false
    PortalPage:
      type: object
      properties:
        key:
          type: string
          pattern: ^[a-z0-9][a-z0-9-]{0,39}$
        title:
          type: string
          minLength: 1
          maxLength: 200
        description:
          type: string
          maxLength: 1000
        kind:
          $ref: '#/components/schemas/PortalPageKind'
        tableId:
          type: string
          minLength: 1
          maxLength: 64
        path:
          maxItems: 4
          type: array
          items:
            $ref: '#/components/schemas/PortalStep'
        where:
          maxItems: 10
          type: array
          items:
            $ref: '#/components/schemas/PortalFilter'
        groupIds:
          maxItems: 20
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 64
        fieldIds:
          maxItems: 50
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 64
        editFieldIds:
          maxItems: 50
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 64
        uploadFieldIds:
          maxItems: 10
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 64
        documentTemplateIds:
          maxItems: 20
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 64
        layout:
          allOf:
          - $ref: '#/components/schemas/PortalPageLayout'
        topicFieldId:
          type: string
          minLength: 1
          maxLength: 64
        sort:
          type: object
          properties:
            fieldId:
              type: string
              minLength: 1
              maxLength: 64
            direction:
              $ref: '#/components/schemas/PortalSortDirection'
          required:
          - fieldId
          - direction
          additionalProperties: false
        imageFieldId:
          type: string
          minLength: 1
          maxLength: 64
        search:
          type: boolean
        resourceId:
          type: string
          minLength: 1
          maxLength: 64
        action:
          allOf:
          - $ref: '#/components/schemas/PortalAction'
      required:
      - key
      - title
      - kind
      additionalProperties: false
    PortalStep:
      type: object
      properties:
        fieldId:
          type: string
          minLength: 1
          maxLength: 64
        reverse:
          type: boolean
        tableId:
          type: string
          minLength: 1
          maxLength: 64
      required:
      - fieldId
      additionalProperties: false
    Portal:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 200
        brand:
          allOf:
          - $ref: '#/components/schemas/PortalBrand'
        contactTableId:
          type: string
          minLength: 1
          maxLength: 64
        enabled:
          type: boolean
        pages:
          minItems: 1
          maxItems: 20
          type: array
          items:
            $ref: '#/components/schemas/PortalPage'
        website:
          type: string
        id:
          type: string
        groupId:
          type: string
        linkVersion:
          type: number
        link:
          type: string
      required:
      - title
      - enabled
      - pages
      - id
      - groupId
      - linkVersion
      additionalProperties: false
    PortalBrandDisplay:
      type: string
      enum:
      - workspace
      - custom
      - hidden
    PortalPageLayout:
      type: string
      enum:
      - list
      - articles
    RegistryFeatureKey:
      type: string
      enum:
      - client-organizations
      - meetings
      - portals
      - web-agents
      - forms
      - cms
      - documents
      - signing
      - mcp
      - desktop-app
      - chrome-extension
      - shared-mailboxes
      - api
      - downloads
      - tutorial-videos
      - videos
      - agent-factory
      - work
      - integrations
      - integrations-catalog
      - records
      - data-model
      - messages
      - inbox
      - mailbox
      - calendar
      - notes
      - reminders
      - files
      - timers
      - dashboards
      - workflows
      - assistant
      - enrichment
      - leads
      - importer
      - templates
      - workspace
      - business-profile
      - meeting-summaries
      - billing
      - partners
      description: 'With reason ''requires'': the required feature that is off'
    PortalFilter:
      type: object
      properties:
        fieldId:
          type: string
          minLength: 1
          maxLength: 64
        equals:
          anyOf:
          - type: string
            maxLength: 500
          - type: number
          - type: boolean
      required:
      - fieldId
      - equals
      additionalProperties: false
    PortalSortDirection:
      type: string
      enum:
      - asc
      - desc
    PortalDefinition:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 200
        brand:
          allOf:
          - $ref: '#/components/schemas/PortalBrand'
        contactTableId:
          type: string
          minLength: 1
          maxLength: 64
        enabled:
          type: boolean
        pages:
          minItems: 1
          maxItems: 20
          type: array
          items:
            $ref: '#/components/schemas/PortalPage'
        website:
          type:
          - string
          - 'null'
          maxLength: 500
          format: uri
      required:
      - title
      - enabled
      - pages
    PortalAction:
      type: object
      properties:
        label:
          type: string
          minLength: 1
          maxLength: 60
        pageKey:
          type: string
          maxLength: 40
        answer:
          type: string
          pattern: ^[a-z][a-z0-9_]{0,40}$
      required:
      - label
      - pageKey
      - answer
      additionalProperties: false
    PortalBrand:
      type: object
      properties:
        display:
          $ref: '#/components/schemas/PortalBrandDisplay'
        name:
          type: string
          maxLength: 120
        logo:
          type: string
          maxLength: 500
      required:
      - display
      additionalProperties: false
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key