List all groups of specified type

List all groups of specified type

get

Authorizations

Path parameters

typeIdstringRequired

Group type id

Example: SDL

Query parameters

statusstring · enumOptional

Status flag to distinguish between active and deleted objects

Example: ACTIVEPossible values:

beforestringOptional

NOT SUPPORTED YET, currently ignored. Cursor that points to the start of the current page of data. If not present, the current page is the first page

afterstringOptional

cursor that points to the end of the current page of data. If not present, the current page is the last page

limitintegerOptional

numbers of items to return

Example: 100

sortOrderstring · enumOptional

Sort query order

Example: ASCPossible values:

Header parameters

X-Symphony-Hoststring · min: 1Required

headers to indentify the originator

Example: localhost.symphony.com

Responses

200

Successful response. Returns the list of all groups

application/json

400

Returned if missing required parameters or wrong parameters

application/json

401

Returned if wrong or missing JWT token

application/json

403

Returned if JWT token missing the required entitlement

application/json

404

Returned if typeId is not found

application/json

429

Returned if the backend is overloaded

application/json

get

HTTPcURLJavaScriptPython

GET /profile-manager/v1/groups/type/{typeId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-Symphony-Host: localhost.symphony.com
Accept: */*

{
  "pagination": {
    "previous": "text",
    "next": "text",
    "cursors": {
      "before": "text",
      "after": "text"
    }
  },
  "data": [
    {
      "type": "SDL",
      "ownerType": "TENANT",
      "ownerId": 100,
      "name": "Test Group"
    },
    {
      "id": "text",
      "createdDate": "2025-05-02T07:16:53.893Z",
      "createdBy": "text",
      "updatedDate": "2025-05-02T07:16:53.893Z",
      "updatedBy": "text",
      "status": "ACTIVE",
      "eTag": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
      "members": [
        {
          "memberTenant": 100,
          "memberId": 12345678900000
        },
        {
          "addedDate": "2025-05-02T07:16:53.893Z"
        }
      ],
      "profile": {
        "displayName": "Test Group",
        "companyName": "Acme Corporation",
        "email": "[e-mail]",
        "mobile": "[phone]",
        "jobTitle": "text",
        "jobRole": "Director",
        "jobDepartment": "text",
        "jobDivision": "text",
        "jobPhone": "text",
        "jobCity": "text",
        "industryOfInterest": [
          "Services"
        ],
        "assetClassesOfInterest": [
          "Equities"
        ],
        "marketCoverage": [
          "EMEA"
        ],
        "responsibility": [
          "Escalation"
        ],
        "function": [
          "Collateral"
        ],
        "instrument": [
          "Equities"
        ],
        "id": "text",
        "avatars": []
      },
      "visibilityRestriction": {
        "restrictedTenantsList": [
          100
        ],
        "restrictedUsersList": [
          12345678900000
        ]
      },
      "implicitConnection": {
        "connectedTenantsList": [
          100
        ],
        "connectedUsersList": [
          12345678900000
        ]
      },
      "interactionTransfer": {
        "restrictedTenantsList": [
          100
        ],
        "restrictedUsersList": [
          12345678900000
        ]
      }
    }
  ]
}