/documenso-documents | Type: Application | PCID required: Yes
Tools
documenso_documents_document_attachment_create
Create attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
documentId | number | Yes | — | Document Id |
documenso_documents_document_attachment_delete
Delete attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
documenso_documents_document_attachment_find
Find attachments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
documenso_documents_document_attachment_update
Update attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
id | string | Yes | — | The id value |
documenso_documents_document_create
Create document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | object | Yes | — | The file value |
payload | object | Yes | — | The payload value |
documenso_documents_document_delete
Delete document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
documenso_documents_document_distribute
Distribute document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
meta | object | No | — | The meta value |
documenso_documents_document_download
Download document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | The ID of the document to download. |
version | string | No | — | The version of the document to download. “signed” returns the completed document with signatures, “original” returns the original uploaded document. |
documenso_documents_document_download_beta
Download document (beta) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | The ID of the document to download. |
version | string | No | — | The version of the document to download. “signed” returns the completed document with signatures, “original” returns the original uploaded document. |
documenso_documents_document_duplicate
Duplicate document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
documenso_documents_document_find
Find documents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The search query. |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
templateId | number | No | — | Filter documents by the template ID used to create it. |
source | string | No | — | Filter documents by how it was created. |
status | string | No | — | Filter documents by the current status |
folderId | string | No | — | Filter documents by folder ID |
orderByColumn | string | No | — | Order By Column |
orderByDirection | string | No | — | Order By Direction |
documenso_documents_document_get
Get document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
documenso_documents_document_get_many
Get multiple documents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentIds | number[] | Yes | — | Document Ids |
documenso_documents_document_redistribute
Redistribute document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | number[] | Yes | — | The recipients value |
documenso_documents_document_update
Update document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | No | — | The data value |
documentId | number | Yes | — | Document Id |
meta | object | No | — | The meta value |
documenso_documents_embedding_presign_create_embedding_presign_token
Create embedding presign token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expiresIn | number | No | — | Expires In |
scope | string | No | — | The scope value |
documenso_documents_embedding_presign_verify_embedding_presign_token
Verify embedding presign token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope | string | No | — | The scope value |
token | string | Yes | — | The token value |
documenso_documents_field_create_document_field
Create document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
field | object | Yes | — | The field value |
documenso_documents_field_create_document_fields
Create document fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
fields | any[] | Yes | — | The fields value |
documenso_documents_field_delete_document_field
Delete document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
documenso_documents_field_get_document_field
Get document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fieldId | number | Yes | — | Field Id |
documenso_documents_field_update_document_field
Update document field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
field | object | Yes | — | The field value |
documenso_documents_field_update_document_fields
Update document fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
fields | any[] | Yes | — | The fields value |
documenso_documents_folder_create_folder
Create new folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
parentId | string | No | — | Parent Id |
type | string | No | — | The type value |
documenso_documents_folder_delete_folder
Delete folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
folderId | string | Yes | — | Folder Id |
documenso_documents_folder_find_folders
Find folders Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The search query. |
page | number | No | — | The pagination page number, starts at 1. |
perPage | number | No | — | The number of items per page. |
parentId | string | No | — | Parent Id |
type | string | No | — | The type value |
documenso_documents_folder_update_folder
Update folder Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data | object | Yes | — | The data value |
folderId | string | Yes | — | Folder Id |
documenso_documents_recipient_create_document_recipient
Create document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipient | object | Yes | — | The recipient value |
documenso_documents_recipient_create_document_recipients
Create document recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | object[] | Yes | — | The recipients value |
documenso_documents_recipient_delete_document_recipient
Delete document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
documenso_documents_recipient_get_document_recipient
Get document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
recipientId | number | Yes | — | Recipient Id |
documenso_documents_recipient_update_document_recipient
Update document recipient Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipient | object | Yes | — | The recipient value |
documenso_documents_recipient_update_document_recipients
Update document recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
documentId | number | Yes | — | Document Id |
recipients | object[] | Yes | — | The recipients value |

