Retrieve a group

Retrieve a group

Retrieve a group

GET/profile-manager/v1/groups/{groupId}

Path parameters

groupId*string

Group id

Example: "WzEwMF1bU0RMXVtUZXN0IEdyb3VwXQ"

Header parameters

Response

200400401403404429

Successful response. Returns the group

Headers

Body

application/json

type*string

Group type identifier

Example: "SDL"

ownerType*Owner (enum)

Owner type. Ony TENANT supported now

Example: "TENANT"

PLATFORMTENANTUSER

ownerId*integer (int64)

Owner id if the owner type is tenant (podId) or user (userId), otherwise null

Example: 100

name*string

Group's name

Example: "Test Group"

idstring

Group's unique identifier

createdDatestring (date-time)

createdBystring

updatedDatestring (date-time)

updatedBystring

statusStatus (enum)

Status flag to distinguish between active and deleted objects

Example: "ACTIVE"

ACTIVEDELETED

eTagstring

Example: "e3a52e72-0854-4401-8c24-e0b17c0ca304"

membersarray of ReadMember (all of)

profileProfile (all of)

visibilityRestrictionGroupVisibilityRestriction (object)

Group visibility restriction.

implicitConnectionGroupImplicitConnection (object)

Group implicit connections.

interactionTransferGroupInteractionTransfer (object)

Group interaction transfer.

Request

JavaScriptCurlPython

const response = await fetch('/profile-manager/v1/groups/{groupId}', {
    method: 'GET',
    headers: {
      "X-Symphony-Host": "localhost.symphony.com"
    },
});
const data = await response.json();

Response

200400401403404429

{
  "type": "SDL",
  "ownerType": "TENANT",
  "ownerId": 100,
  "name": "Test Group",
  "id": "text",
  "createdDate": "2024-11-21T06:23:23.662Z",
  "createdBy": "text",
  "updatedDate": "2024-11-21T06:23:23.662Z",
  "updatedBy": "text",
  "status": "ACTIVE",
  "eTag": "e3a52e72-0854-4401-8c24-e0b17c0ca304",
  "members": [
    {
      "memberTenant": 100,
      "memberId": 12345678900000,
      "addedDate": "2024-11-21T06:23:23.662Z"
    }
  ],
  "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": [
      {
        "size": "text",
        "url": "text"
      }
    ]
  },
  "visibilityRestriction": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  },
  "implicitConnection": {
    "connectedTenantsList": [
      100
    ],
    "connectedUsersList": [
      12345678900000
    ]
  },
  "interactionTransfer": {
    "restrictedTenantsList": [
      100
    ],
    "restrictedUsersList": [
      12345678900000
    ]
  }
}