Retrieves information, including group member information, for the specified signing group.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

signingGroupIdstring

Optional. The ID of the signing group.

Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.

Responses

CodeDescriptionReference
200

Successful response.

SigningGroups
400

Error encountered.

errorDetails

SDK Method

SigningGroups::get

Definitions

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

signingGroupUser

emailstring

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and 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

The name of the user who created the signing group.

errorDetailserrorDetails

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

groupEmailstring

The email address for the signing group. You can use a group email address to email all of the group members at the same time.

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. Possible values include:

  • adminstrators
  • everyone
  • customGroup
  • sharedSigningGroup

modifiedstring

The date and time that the signing group was last modified.

modifiedBystring

The 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
{
  "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
<signingGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <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> 
}} />