Retrieve a group

Get SDL group information

get

Path parameters

groupIdinteger · int64 · min: 1Required

Group identifier

Example: 71811853191697

Header parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

Ok

application/json

Group account base properties

groupIdinteger · int64 · min: 1Optional

Group identifier

Example: 71811853191697

namestringOptional

Group name.

usernamestringOptional

Username identificator of the Group

typestring · enumOptional

Group type

Possible values:

activebooleanOptional

Define if group is currently active or deleted.

displayNamestringOptional

Display name

companyNamestringOptional

Company name

emailstringOptional

Email address

restrictedTenantsinteger · int32[]OptionalExample: 1008

eTagstringOptional

Group account eTag

createdDateinteger · int64Optional

Group account creation timestamp (Unix epoch milliseconds)

createdBystringOptional

Group account creator

updatedDateinteger · int64Optional

Group account last modification timestamp (Unix epoch milliseconds)

updatedBystringOptional

Group account updater

marketCoveragestring[]Optional

instrumentstring[]Optional

responsibilitystring[]Optional

functionstring[]Optional

400

Client error, see response body for further details.

application/json

401

Unauthorized, Invalid credentials.

application/json

500

Server error, see response body for further details.

application/json

get/v1/groups/sdl/{groupId}

GET /v1/groups/sdl/{groupId} HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

{
  "groupId": 71811853191697,
  "name": "text",
  "username": "text",
  "type": "SDL",
  "active": true,
  "displayName": "text",
  "companyName": "text",
  "email": "text",
  "members": [
    {
      "userId": 71811853191697,
      "tenantId": 1,
      "addedDate": 1
    }
  ],
  "restrictedTenants": [
    1008
  ],
  "avatars": {
    "50": "text",
    "150": "text",
    "500": "text",
    "600": "text",
    "orig": "text"
  },
  "eTag": "text",
  "createdDate": 1,
  "createdBy": "text",
  "updatedDate": 1,
  "updatedBy": "text",
  "marketCoverage": [
    "text"
  ],
  "instrument": [
    "text"
  ],
  "responsibility": [
    "text"
  ],
  "function": [
    "text"
  ]
}