> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Documents Resource Documents resource > **Warning** > > Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact [Docusign Sales](https://www.docusign.com/contact-sales). ## Methods supported | Method | Description | | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | [Delete](/docs/clm-api/reference/objects/documents/delete) | DEL `/v2/{accountId}/documents/{id}` Move a document to the trash folder. | | [DeleteLock](/docs/clm-api/reference/objects/documents/deletelock) | DEL `/v2/{accountId}/documents/{id}/lock` Release a lock on a document | | [Get](/docs/clm-api/reference/objects/documents/get) | GET `/v2/{accountId}/documents/{id}` Get a document by ID | | [GetAttachedDocuments](/docs/clm-api/reference/objects/documents/getattacheddocuments) | GET `/v2/{accountId}/documents/{id}/attacheddocuments` Get attached documents | | [GetByPath](/docs/clm-api/reference/objects/documents/getbypath) | GET `/v2/{accountId}/documents` Get a document by path | | [GetCustomData](/docs/clm-api/reference/objects/documents/getcustomdata) | GET `/v2/{accountId}/documents/{id}/customdata` Query a CSV document by ID | | [GetDocumentProcessTrackingActivities](/docs/clm-api/reference/objects/documents/getdocumentprocesstrackingactivities) | GET `/v2/{accountId}/documents/{id}/documentprocesstrackingactivities` Get the workflow user steps containing a document | | [GetDocumentReminders](/docs/clm-api/reference/objects/documents/getdocumentreminders) | GET `/v2/{accountId}/documents/{id}/documentreminders` Get the document reminders for a document | | [GetDocumentWorkItems](/docs/clm-api/reference/objects/documents/getdocumentworkitems) | GET `/v2/{accountId}/documents/{id}/workitems` Get workitems associated with the document | | [GetExternalReviewFromDocument](/docs/clm-api/reference/objects/documents/getexternalreviewfromdocument) | GET `/v2/{accountId}/documents/{id}/reviews` Gets the external review associated with the document | | [GetHistoryItems](/docs/clm-api/reference/objects/documents/gethistoryitems) | GET `/v2/{accountId}/documents/{id}/historyItems` Get the history of a document | | [GetLock](/docs/clm-api/reference/objects/documents/getlock) | GET `/v2/{accountId}/documents/{id}/lock` Get the lock status of a document | | [GetRelatedDocuments](/docs/clm-api/reference/objects/documents/getrelateddocuments) | GET `/v2/{accountId}/documents/{id}/relateddocuments` Get related documents | | [GetShareLinks](/docs/clm-api/reference/objects/documents/getsharelinks) | GET `/v2/{accountId}/documents/{id}/sharelinks` Get the share links of a document | | [GetVersions](/docs/clm-api/reference/objects/documents/getversions) | GET `/v2/{accountId}/documents/{id}/versions` Get the versions of a document | | [Patch](/docs/clm-api/reference/objects/documents/patch) | PATCH `/v2/{accountId}/documents/{id}` Update a document | | [PatchLock](/docs/clm-api/reference/objects/documents/patchlock) | PATCH `/v2/{accountId}/documents/{id}/lock` Update a lock on a document | | [PostLock](/docs/clm-api/reference/objects/documents/postlock) | POST `/v2/{accountId}/documents/{id}/lock` Create a lock on a document | | [PublishDocument](/docs/clm-api/reference/objects/documents/publishdocument) | POST `/v2/{accountId}/documents/{id}/publish` Publishes document by ID. Returns document information. | | [Put](/docs/clm-api/reference/objects/documents/put) | PUT `/v2/{accountId}/documents/{id}` Update a document | | [PutLock](/docs/clm-api/reference/objects/documents/putlock) | PUT `/v2/{accountId}/documents/{id}/lock` Update a lock on a document | ## Documents properties | Property | Type | Description | | ----------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AccessLevel` | AccessLevel | Permissions on the document for the current user | | `AttachedDocuments` | ApiCollection_Document\_ | Attached documents | | `AttributeGroups` | object | A list of attribute group specifications to refine search | | `ContentCreatedDate` | string (date-time) | Date when the document was ingested/uploaded | | `CreatedBy` | string | Username of the user that created the clause. Sortable | | `CreatedDate` | string (date-time) | Date and time the workflow definition was created | | `Description` | string | Description of the group. Filterable and sortable | | `DocumentProcessTrackingActivities` | ApiCollection_DocumentProcessTrackingActivity\_ | Workflow user steps containing the document | | `DocumentReminders` | ApiCollection_DocumentReminder\_ | Document reminders set for the document | | `DownloadDocumentHref` | string | Uri where the document can be downloaded | | `EosParentInfo` | EosInfo | Information about the external object storage folder that contains the document | | `Extension` | string | Document extension | | `HistoryItems` | ApiCollection_HistoryItem\_ | A history of actions performed on the document | | `Href` | string | Uri where the object can be retrieved. | | `IsInTrash` | boolean | Whether the document is in trash or not | | `Lock` | DocumentLock | The current lock status of the document | | `LockStatus` | string | Indicates the checked-out status of the latest version of the document. This field is populated for the latest version of the document. Load Lock Object for more details. | | `Name` | string | The name of the workflow as given in the workflow designer. Required when starting a new workflow | | `NativeFileSize` | integer (int64) | File size in bytes | | `PageCount` | integer (int32) | The page length of the document | | `ParentFolder` | Folder | Folder containing the clause | | `Path` | string | The file path of the document within the account's folder structure | | `PdfFileSize` | integer (int64) | PDF rendition of file size in bytes | | `PreviewUrl` | string | Uri where a preview of the document can be viewed | | `RelatedDocuments` | ApiCollection_Document\_ | Related documents | | `Score` | number (float) | ElasticSearch relevancy score | | `ShareLinks` | ApiCollection_ShareLink\_ | Share links that have been created for the document | | `Uid` | string | Document Uid | | `UpdatedBy` | string | Search for who last updated an object | | `UpdatedDate` | string (date-time) | Date and time the workflow definition was last updated | | `Version` | string | Version number of the document. Increments as the document is checked out and checked back in | | `Versions` | ApiCollection_Document\_ | Other versions of the document | | `WorkItems` | ApiCollection_WorkItem\_ | Work items for the document | ## API Docs - Documents [Move document to trash folder](https://developers.docusign.com/docs/clm-api/reference/objects/documents/delete.md) - Documents [Release lock on document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/deletelock.md) - Documents [Get document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/get.md) - Documents [Get attached documents](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getattacheddocuments.md) - Documents [Get document by path](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getbypath.md) - Documents [Query CSV document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getcustomdata.md) - Documents [Get workflow user steps containing document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getdocumentprocesstrackingactivities.md) - Documents [Get document reminders for document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getdocumentreminders.md) - Documents [Get workitems associated with document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getdocumentworkitems.md) - Documents [Get external review associated with document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getexternalreviewfromdocument.md) - Documents [Get history of document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/gethistoryitems.md) - Documents [Get lock status of document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getlock.md) - Documents [Get related documents](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getrelateddocuments.md) - Documents [Get share links of document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getsharelinks.md) - Documents [Get versions of document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/getversions.md) - Documents [Update document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/patch.md) - Documents [Update lock on document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/patchlock.md) - Documents [Create lock on document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/postlock.md) - Documents [Publish document](https://developers.docusign.com/docs/clm-api/reference/objects/documents/publishdocument.md) - Documents [Put](https://developers.docusign.com/docs/clm-api/reference/objects/documents/put.md) - Documents [Put lock](https://developers.docusign.com/docs/clm-api/reference/objects/documents/putlock.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.docusign.com/openapi.json) - [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)