Symphony

Symphony Onboarding API

The Onboarding API from Symphony — 1 operation(s) for onboarding.

GitHub OpenAPI

Operations 1

GET /v1/onboarding/tenant Symphony Get User's Pod and Availability for Onboarding #

Documentation

📖
Documentation
https://docs.developers.symphony.com/bots/overview-of-rest-api/agent-api
📖
Documentation
https://docs.developers.symphony.com/bots/authentication
📖
Documentation
https://docs.developers.symphony.com/bots/authentication/rsa-authentication
📖
Documentation
https://developers.symphony.com/
📖
Documentation
https://docs.developers.symphony.com/symphony-rest-api/connect-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/symphony/refs/heads/main/openapi/symphony-onboarding-api-openapi.yml

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/symphony-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

symphony-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Symphony Community Connect Onboarding API
  description: Community Connect public API
  version: 1.3.0
security:
- JwtAuth: []
- ApiKeyAuth: []
tags:
- name: Onboarding
paths:
  /v1/onboarding/tenant:
    get:
      tags:
      - Onboarding
      security:
      - ApiKeyAuth: []
      summary: Symphony Get User's Pod and Availability for Onboarding
      operationId: getUserOnboardingAvailability
      parameters:
      - name: email
        in: query
        schema:
          type: string
        required: true
        description: The user email
        example: user@companyDomain.com
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserOnboardingAvaibilityResponse'
              example: Company is already on Symphony but user needs access
        '400':
          description: Something was wrong about the request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: error code
        message:
          type: string
          description: Human readable details about the error
        details:
          description: Full details about error, usefull for 400
          type: object
    UserOnboardingAvaibilityResponse:
      allOf:
      - $ref: '#/components/schemas/ApiInfo'
      - type: object
        properties:
          podUrl:
            type: string
            example: ces4-dev.symphony.com
    ApiInfo:
      type: object
      properties:
        code:
          type: string
          description: info code
        message:
          type: string
          description: Human readable details about the information the api is returning
        details:
          description: Full details about info
          type: object
  securitySchemes:
    JwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: ExtApp JWT
    ApiKeyAuth:
      type: apiKey
      in: query
      name: token
    CommonJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Common JWT