Jump to

• Request
• Response

Retrieve a Group

get

/ic/api/process/v1/identities/groups/{groupid}

Retrieves a group by group ID.

Request

Path Parameters

• groupid(required): string
  The value of the group ID

Query Parameters

• includeDirectReporteesFlag: boolean
  If true details of the direct reportees of participant will be returned, if false- not, default is true

  Default Value: true
• includeManagerFlag: boolean
  If true details of the participant's manager name will be returned, if false- not, default is true

  Default Value: true

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : GroupResponse

Type: object

Show Source

• email: string
• participants: object Collection

{
    "type":"object",
    "properties":{
        "email":{
            "type":"string"
        },
        "participants":{
            "$ref":"#/definitions/CollectionUser"
        }
    }
}

Nested Schema : Collection

Type: object

400 Response

Bad request

401 Response

Unauthorized

404 Response

Group not found for ID

500 Response

Internal Server Error

Back to Top