List principals request is shared with | Docusign

{
  "_links": {
    "self": {
      "href": "https://api.docusign.com/v1/accounts/9f8e7d6c-1234-4a5b-8c9d-0e1f2a3b4c5d/requests/3f7c9e4b-851c-4f9b-89e7-123456789abc/shares"
    },
    "request": {
      "href": "https://api.docusign.com/v1/accounts/9f8e7d6c-1234-4a5b-8c9d-0e1f2a3b4c5d/requests/3f7c9e4b-851c-4f9b-89e7-123456789abc"
    }
  },
  "response_metadata": {
    "request_id": "3f7c9e4b-851c-4f9b-89e7-123456789abc",
    "response_timestamp": "2026-08-26T14:30:00Z",
    "page_limit": 25
  },
  "principals": [
    {
      "id": "bbbb2222-cccc-4ddd-8eee-ffff33334444",
      "role": "MANAGE",
      "type": "user"
    },
    {
      "id": "77777777-7777-4777-8777-777777777777",
      "role": "VIEW",
      "type": "group"
    }
  ]
}

Returns the users and groups that have been granted access to the specified request, along with the role each holds.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account that owns the request statuses.

requestIdstringRequiredformat: "uuid"

The ID of the request (Agreement Desk ticket) the document belongs to.

Response

The principals the request is shared with.

_linksobjectOptional

Hypermedia links for a request’s shares: a PageLinks superset (paging controls) plus a link back to the parent request.

response_metadataobjectOptional

Control information and metadata for the response.

principalslist of objectsOptional

The principals that have been granted access to the request.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error