Groups: list

Retrieves information about groups associated with the account.

Request

HTTP request

GET /v2/accounts/{accountId}/groups

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Optional query parameters
count string

Number of records to return. The number must be greater than 1 and less than or equal to 100.

group_type string
search_text string
start_position string

Starting value for the list.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Groups::listGroups

Definitions Expand All | Collapse All

Groups

Group information

endPosition string

The last position in the result set.

groups
[group]

A collection group objects containing information about the groups returned.

nextUri string

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUri string

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSize string

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

group

errorDetails errorDetails
groupId string

The DocuSign group ID for the group.

groupName string

The name of the group. The search_text provided in the call automatically performs a wild card search on group_name.

groupType string

The group type.

permissionProfileId string

The ID of the permission profile associated with the group.

users
[userInfo]

userInfo

activationAccessCode string
email string
errorDetails errorDetails
loginStatus string
sendActivationEmail string
uri string
userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

userName string
userStatus string

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled
userType string

Examples

Generic JSON Response

Response

{
"groups": [
{
"groupId": "sample string 1",
"groupName": "sample string 2",
"permissionProfileId": "sample string 3",
"groupType": "sample string 4",
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9",
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2"
}
}
]
,
"errorDetails": {
"errorCode": "SUCCESS",
"message": ""
}
}
]
,
"resultSetSize": "sample string 1",
"totalSetSize": "sample string 2",
"startPosition": "sample string 3",
"endPosition": "sample string 4",
"nextUri": "sample string 5",
"previousUri": "sample string 6"
}

Generic XML Response

Response

<groupInformation 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<endPosition>sample string 4</endPosition>
<nextUri>sample string 5</nextUri>
<previousUri>sample string 6</previousUri>
<resultSetSize>sample string 1</resultSetSize>
<startPosition>sample string 3</startPosition>
<totalSetSize>sample string 2</totalSetSize>
<groups>
<group>
<errorDetails>
<errorCode>SUCCESS</errorCode>
<message></message>
</errorDetails>
<groupId>sample string 1</groupId>
<groupName>sample string 2</groupName>
<groupType>sample string 4</groupType>
<permissionProfileId>sample string 3</permissionProfileId>
<users>
<userInfo>
<activationAccessCode>sample string 9</activationAccessCode>
<email>sample string 3</email>
<errorDetails>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<loginStatus>sample string 7</loginStatus>
<sendActivationEmail>sample string 8</sendActivationEmail>
<uri>sample string 6</uri>
<userId>sample string 2</userId>
<userName>sample string 1</userName>
<userStatus>sample string 5</userStatus>
<userType>sample string 4</userType>
</userInfo>
</users>
</group>
</groups>
</groupInformation>