Groups REST Endpoints

Sort by

Task Path Method

Groups

The Groups REST API services supports groups for partner organizations and the host company via REST API services.

Bulk Update Users within Groups

Method: patch

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/users

Create a Group for Host Company or Partner Organization

Method: post

Path: /rest/v19/companies/{companyLoginName}/groups

Get a Group for Host Company or Partner Organization

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}

Get All Access Segments for a Group

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments

Get All Groups

Method: get

Path: /rest/v19/groups

Get All Users of a Group

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/users

Get Data Table Access Rights

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/folders/{folderVarName}/accessRights

Get Groups for the Host Company or for a Partner Organization

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups

Get Pricing Access Rights for a Group

Method: get

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments/_pricing/subSegments/{segmentVarName}/accessRights

Update a Group for Host Company or Partner Organization

Method: put

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}

Update Data Tables Access Rights for a Group

Method: post

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments/_dataTables/actions/updateAccessRights

Update Group Access Segments for a Group

Method: patch

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments

Update Pricing Access Rights for a Group

Method: post

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments/_pricing/actions/updateAccessRights

Update Specific Group Details for the Host Company or Partner Organization

Method: patch

Path: /rest/v19/companies/{companyLoginName}/groups/{groupVarName}