Accounts: getGroups

Required scopes: group_read

Returns the list of groups in an account.

Request

HTTP request

GET /v2/organizations/{organizationId}/accounts/{accountId}/groups

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

accountIdstring

The account ID Guid

SDK Method

Accounts::getGroups

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.MemberGroupsResponse

A response about member groups. It contains the groups and paging information.

groups[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.MemberGroupResponse]

A list of the responses.

pagingDocuSign.Account.Common.Models.RestApi.Response.PagingResponseProperties

Informatiobn about paging though the responses.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.MemberGroupResponse

And individual group responses,.

idinteger

The unique ID of the group.

namestring

The name of the group.

typestring

The type of group. One of:

  • invalid
  • admin_group
  • everyone_group
  • custom_group

DocuSign.Account.Common.Models.RestApi.Response.PagingResponseProperties

Information about paging through results.

result_set_sizeinteger

Number of items in a result set (page).

result_set_start_positioninteger

Index of the first result in this set.

result_set_end_positioninteger

Index of the last result in this set.

total_set_sizeinteger

Total number of results.

nextstring

A URL to the next set of results.

previousstring

A URL to the previous set of results.

Examples

Generic JSON Response

Response
{
  "groups": [
    {
      "id": 11148,
      "name": "Administrators",
      "type": 1
    },
    {
      "id": 11149,
      "name": "Everyone",
      "type": 2
    }
  ],
  "paging": {
    "result_set_size": 2,
    "result_set_start_position": 0,
    "result_set_end_position": 1,
    "total_set_size": 2
  }
}
Generic XML Request

Request
<Not applicable for Org Admin API>
}} />