Retrieve a Group

get

/identities/group/{groupid}

Retrieves a group by group ID.

• Request
• Response
• Examples

Request

There are no request parameters for this operation.

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Root Schema : /paths/~1identities~1group~1{groupid}/get/responses/200/schema

Examples

The following example shows a response body when retrieving a group by group ID.

{
                      "levels": 0,
                      "id": "LoanAnalyticGroup",
                      "type": "group",
                      "email": "",
                      "participants": {
                      "totalResult": false,
                      "hasMore": false,
                      "items": [{
                      "levels": 0,
                      "id": "mmitch",
                      "type": "user",
                      "email": "[e-mail]",
                      "firstName": "Margaret",
                      "lastName": "Mitchell",
                      "mobile": "300000012",
                      "workPhone": "100000012",
                       "country": "US",
                      "language": "en",
                      "adminFlag": false,
                      "manager": {
                      "href": "http://example.com/bpm/api/3.0/identities/user/fkafka",
                      "length": 0,
                      "rel": "manager"
                        },
                      "reportees": {
                      "totalResult": false,
                       "hasMore": false,
                       "items": []
                           },
                       "homePhone": "200000012"
                        }, {
                      "levels": 0,
                      "id": "szweig",
                       "type": "user",
                       "email": "[e-mail]",
                       "firstName": "Stefan",
                       "lastName": "Zweig",
                       "mobile": "300000011",
                       "workPhone": "100000011",
                       "country": "US",
                       "language": "en",
                        "adminFlag": false,
                       "manager": {
                        "href": "http://example.com/bpm/api/3.0/identities/user/szweigidentities/user/fkafka",
                          "length": 0,
                          "rel": "manager"
                       },
                      "reportees": {
                     "totalResult": false,
                      "hasMore": false,
                     "items": []
                      },
                       "homePhone": "200000011"
                      }]
                      }

For more information about cURL, see Use cURL