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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

signingGroupId string

Responses

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

SDK Method

SigningGroups::get

Definitions Expand All | Collapse All

SigningGroups

Signing groups

created string

The UTC DateTime when the workspace user authorization was created.

createdBy string
errorDetails errorDetails
groupEmail string
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.

modified string
modifiedBy string
signingGroupId string

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]

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.

signingGroupUser

email string
errorDetails errorDetails
userName string

The name of the group member.

Maximum Length: 100 characters.

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>