Retrieves a list of all signing groups in the specified account.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
group_typestring

include_usersstring

When set to true, the response includes the signing group members.

Responses

CodeDescriptionReference
200

Successful response.

signingGroupInformation
400

Error encountered.

errorDetails

SDK Method

SigningGroups::list

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.

signingGroupInformation

groups[SigningGroups]

A collection group objects containing information about the groups returned.

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.

SigningGroups

Signing groups

createdstring

The UTC DateTime when the workspace user authorization was created.

createdBystring

errorDetailserrorDetails

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

groupEmailstring

groupNamestring

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

groupTypestring

The group type. Potential values for POST and PUT requests include:

  • adminstrators
  • everyone
  • customGroup

modifiedstring

modifiedBystring

User ID (GUID) of the user who last modified this user record.

signingGroupIdstring

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

users[signingGroupUser]

User management information.

Examples

Generic JSON Response

Response
{
  "groups": [
    {
      "signingGroupId": "sample string 1",
      "groupName": "sample string 2",
      "groupType": "sample string 3",
      "groupEmail": "sample string 4",
      "created": "sample string 5",
      "createdBy": "sample string 6",
      "modified": "sample string 7",
      "modifiedBy": "sample string 8",
      "users": [
        {
          "userName": "sample string 1",
          "email": "sample string 2",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        }
      ],
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      }
    }
  ]
}
Generic XML Response

Response
<signingGroupInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <groups>
    <signingGroup>
      <created>sample string 5</created>
      <createdBy>sample string 6</createdBy>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <groupEmail>sample string 4</groupEmail>
      <groupName>sample string 2</groupName>
      <groupType>sample string 3</groupType>
      <modified>sample string 7</modified>
      <modifiedBy>sample string 8</modifiedBy>
      <signingGroupId>sample string 1</signingGroupId>
      <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>
    </signingGroup>
  </groups>
</signingGroupInformation> 
}} />