Retrieves the list of members in the specified Signing Group.

Request

HTTP request

GET /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

signingGroupIdstring

The id of the signing group of which the recipient is a member, if applicable.

Responses

CodeDescriptionReference
200

Successful response.

SigningGroupUsers
400

Error encountered.

errorDetails

SDK Method

SigningGroups::listUsers

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

signingGroupUser

emailstring

Filters returned user records by the specified email address.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

userNamestring

The name of the group member.

Maximum Length: 100 characters.

SigningGroupUsers

Signing groups' users

users[signingGroupUser]

User management information.

Examples

Generic JSON Response

Response
{
  "users": [
    {
      "userName": "sample string 1",
      "email": "sample string 2",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<signingGroupUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <users>
    <signingGroupUser>
      <email>sample string 2</email>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <userName>sample string 1</userName>
    </signingGroupUser>
  </users>
</signingGroupUsers> 
}} />