How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Symphony Groups API

The Groups API from Symphony — 6 operation(s) for groups.

Symphony Groups API is one of 20 APIs that Symphony publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, /profile-manager.

5 operations 4 paths 16 schemas 1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://acme.symphony.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Symphony Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Use Common JWT

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 5
POST
/v1/groups/{groupId}/member
Symphony Add a New User to a an Existing Group
addMemberToGroup 2 params body → 200400401403429452
POST
/v1/groups
Symphony Insert a New Group
insertGroup 1 param body → 201400401403429452
GET
/v1/groups/{groupId}
Symphony Retrieve a Group
getGroup 2 params → 200400401403404429
PUT
/v1/groups/{groupId}
Symphony Update a Group
updateGroup 3 params body → 200400401403404412429452
POST
/v1/groups/{groupId}/avatar
Symphony Update the Group Avatar
updateAvatar 2 params body → 200400401403404429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BaseProfile (16 properties), BaseGroup (4 properties), GroupVisibilityRestriction (2 properties), Member (2 properties). Each schema is shown below with its type and property counts.

addMember
object
1 property
Status
string
Status flag to distinguish between active and deleted objects
Owner
string
Owner type. Ony TENANT supported now
UpdateGroup
Avatar
object
2 properties
BaseProfile
object
The group's profile. Please note that in case of a company group type, the profile shouldn't be provided when creating a new company and do not exist in case o…
16 properties
GroupInteractionTransfer
object
Group interaction transfer.
2 properties
Member
object
A Group member.
2 properties
GroupVisibilityRestriction
object
Group visibility restriction.
2 properties
UploadAvatar
object
1 property
ReadMember
ReadGroup
CreateGroup
Profile
BaseGroup
object
A reduced set Group object, for retrieving list of group purpose
4 properties 4 required
GroupImplicitConnection
object
Group implicit connections.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

symphony-groups-api-openapi.yml Raw ↑

Other APIs Symphony publishes across the network.

Symphony All API
Symphony App API
Symphony Audittrail API
Symphony Authenticate API
Symphony Channelco API
Symphony Datafeeds API
Symphony Dlp API
Symphony Events API
Symphony Health API
Symphony Idm API
Symphony Info API
Symphony Logout API
Where this information came from

This is an independent, third-party profile of Symphony Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.