Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Groups

Gets information about groups associated with the account

GET
/v2.1/accounts/{accountId}/groups

Gets information about groups associated with the account.

  1. Use this endpoint to get the group ID.
  2. Use listGroupUsers to get the list of users.

Related topics

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

Query Parameters

count?string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Valid values: 1 to 100

group_type?string

The type of group to return. Valid values:

  • AdminGroup
  • CustomGroup
  • EveryoneGroup
include_usercount?string

When true, every group returned in the response includes a userCount property that contains the total number of users in the group. The default is true.

search_text?string

Filters the results of a GET request based on the text that you specify.

start_position?string

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/groups"
{  "endPosition": "string",  "groups": [    {      "accessType": "string",      "dsGroupId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "groupId": "string",      "groupName": "string",      "groupType": "string",      "isManagedByScim": true,      "lastModifiedOn": "string",      "permissionProfileId": "string",      "userGroupType": "string",      "users": [        {          "accountId": "string",          "accountName": "string",          "activationAccessCode": "string",          "email": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "ipAddress": "string",          "loginStatus": "string",          "membershipId": "string",          "sendActivationEmail": "string",          "uri": "string",          "userId": "string",          "userName": "string",          "userStatus": "string",          "userType": "string"        }      ],      "usersCount": "string"    }  ],  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}

Adds an existing brand to a group PUT

This method adds one or more existing brands to a group based on the `groupId`.

Creates one or more groups for the account POST

Creates one or more groups for the account. Groups help you manage users. For example, you can use groups to limit user access to templates. You can associate a group with a [permission profile](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/permissions/), which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set permission profiles for a group, but it makes it easier to manage user permissions for a large number of users. <ds-inlinemessage kind="warning" markdown="1"> This endpoint uses only the <code>groupName</code> and <code>permissionProfileId</code> properties in the request body. All other properties are ignored. </ds-inlinemessage> Example request: ```json { "groups": [ { "groupName": "montagues" }, { "groupName": "capulets" }, { "groupName": "nobles", "permissionProfileId": 1597 } ] } ``` Use [AccountPermissionProfiles: list](https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. It is an error if the `permissionProfileId` does not exist. ### Related topics - [How-To Set Up a Permission Profile](https://developers.docusign.com/docs/esign-rest-api/how-to/permission-profile-setting/)