List signature definitions

GET

/v2.1/accounts/:accountId/users/:userId/signatures

GET

/restapi/v2.1/accounts/:accountId/users/:userId/signatures

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/users/USER_ID/signatures \
     -H "Authorization: Bearer <apiKey>"

{
  "userSignatures": [
    {
      "adoptedDateTime": "sample string 1",
      "createdDateTime": "sample string 2",
      "customField": "sample string 3",
      "dateStampProperties": {
        "dateAreaHeight": "sample string 1",
        "dateAreaWidth": "sample string 2",
        "dateAreaX": "sample string 3",
        "dateAreaY": "sample string 4"
      },
      "disallowUserResizeStamp": "sample string 4",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      },
      "externalID": "sample string 5",
      "imageBase64": "sample string 6",
      "imageType": "sample string 7",
      "initials150ImageId": "sample string 8",
      "initialsImageUri": "sample string 9",
      "isDefault": "sample string 10",
      "lastModifiedDateTime": "sample string 11",
      "nrdsId": "sample string 12",
      "nrdsLastName": "sample string 13",
      "nrdsStatus": "sample string 14",
      "phoneticName": "sample string 15",
      "signature150ImageId": "sample string 16",
      "signatureFont": "sample string 17",
      "signatureId": "sample string 18",
      "signatureImageUri": "sample string 19",
      "signatureInitials": "sample string 20",
      "signatureName": "sample string 21",
      "signatureRights": "sample string 22",
      "signatureType": "sample string 23",
      "stampFormat": "sample string 24",
      "stampImageUri": "sample string 25",
      "stampSizeMM": "sample string 26",
      "stampType": "sample string 27",
      "status": "sample string 28"
    }
  ]
}

This method retrieves the signature definitions for the user that you specify.

The userId parameter specified in the endpoint must match the authenticated user’s user ID, and the user must be a member of the account.

The signatureId parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (signatureId), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint.

For example, encode “Bob Smith” as “Bob%20Smith”.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

userIdstringRequired

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user’s settings.

Query parameters

stamp_typestringOptional

The type of stamps to return. Valid values are:

signature: Returns information about signature images only. This is the default value.
stamp: Returns information about eHanko and custom stamps only.
null

Response

Successful response.

userSignatureslist of objectsOptional

An array of userSignature objects.

Errors

400

Bad Request Error