Skip to main content
Server path: /documenso-documents | Type: Application | PCID required: Yes

Tools

ToolDescription
documenso_documents_document_attachment_createCreate attachment
documenso_documents_document_attachment_deleteDelete attachment
documenso_documents_document_attachment_findFind attachments
documenso_documents_document_attachment_updateUpdate attachment
documenso_documents_document_createCreate document
documenso_documents_document_deleteDelete document
documenso_documents_document_distributeDistribute document
documenso_documents_document_downloadDownload document
documenso_documents_document_download_betaDownload document (beta)
documenso_documents_document_duplicateDuplicate document
documenso_documents_document_findFind documents
documenso_documents_document_getGet document
documenso_documents_document_get_manyGet multiple documents
documenso_documents_document_redistributeRedistribute document
documenso_documents_document_updateUpdate document
documenso_documents_embedding_presign_create_embedding_presign_tokenCreate embedding presign token
documenso_documents_embedding_presign_verify_embedding_presign_tokenVerify embedding presign token
documenso_documents_field_create_document_fieldCreate document field
documenso_documents_field_create_document_fieldsCreate document fields
documenso_documents_field_delete_document_fieldDelete document field
documenso_documents_field_get_document_fieldGet document field
documenso_documents_field_update_document_fieldUpdate document field
documenso_documents_field_update_document_fieldsUpdate document fields
documenso_documents_folder_create_folderCreate new folder
documenso_documents_folder_delete_folderDelete folder
documenso_documents_folder_find_foldersFind folders
documenso_documents_folder_update_folderUpdate folder
documenso_documents_recipient_create_document_recipientCreate document recipient
documenso_documents_recipient_create_document_recipientsCreate document recipients
documenso_documents_recipient_delete_document_recipientDelete document recipient
documenso_documents_recipient_get_document_recipientGet document recipient
documenso_documents_recipient_update_document_recipientUpdate document recipient
documenso_documents_recipient_update_document_recipientsUpdate document recipients

documenso_documents_document_attachment_create

Create attachment Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value
documentIdnumberYesDocument Id

documenso_documents_document_attachment_delete

Delete attachment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

documenso_documents_document_attachment_find

Find attachments Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id

documenso_documents_document_attachment_update

Update attachment Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value
idstringYesThe id value

documenso_documents_document_create

Create document Parameters:
ParameterTypeRequiredDefaultDescription
fileobjectYesThe file value
payloadobjectYesThe payload value

documenso_documents_document_delete

Delete document Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id

documenso_documents_document_distribute

Distribute document Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
metaobjectNoThe meta value

documenso_documents_document_download

Download document Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesThe ID of the document to download.
versionstringNoThe 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:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesThe ID of the document to download.
versionstringNoThe 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:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id

documenso_documents_document_find

Find documents Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoThe search query.
pagenumberNoThe pagination page number, starts at 1.
perPagenumberNoThe number of items per page.
templateIdnumberNoFilter documents by the template ID used to create it.
sourcestringNoFilter documents by how it was created.
statusstringNoFilter documents by the current status
folderIdstringNoFilter documents by folder ID
orderByColumnstringNoOrder By Column
orderByDirectionstringNoOrder By Direction

documenso_documents_document_get

Get document Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id

documenso_documents_document_get_many

Get multiple documents Parameters:
ParameterTypeRequiredDefaultDescription
documentIdsnumber[]YesDocument Ids

documenso_documents_document_redistribute

Redistribute document Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
recipientsnumber[]YesThe recipients value

documenso_documents_document_update

Update document Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectNoThe data value
documentIdnumberYesDocument Id
metaobjectNoThe meta value

documenso_documents_embedding_presign_create_embedding_presign_token

Create embedding presign token Parameters:
ParameterTypeRequiredDefaultDescription
expiresInnumberNoExpires In
scopestringNoThe scope value

documenso_documents_embedding_presign_verify_embedding_presign_token

Verify embedding presign token Parameters:
ParameterTypeRequiredDefaultDescription
scopestringNoThe scope value
tokenstringYesThe token value

documenso_documents_field_create_document_field

Create document field Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
fieldobjectYesThe field value

documenso_documents_field_create_document_fields

Create document fields Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
fieldsany[]YesThe fields value

documenso_documents_field_delete_document_field

Delete document field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_documents_field_get_document_field

Get document field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdnumberYesField Id

documenso_documents_field_update_document_field

Update document field Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
fieldobjectYesThe field value

documenso_documents_field_update_document_fields

Update document fields Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
fieldsany[]YesThe fields value

documenso_documents_folder_create_folder

Create new folder Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value
parentIdstringNoParent Id
typestringNoThe type value

documenso_documents_folder_delete_folder

Delete folder Parameters:
ParameterTypeRequiredDefaultDescription
folderIdstringYesFolder Id

documenso_documents_folder_find_folders

Find folders Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoThe search query.
pagenumberNoThe pagination page number, starts at 1.
perPagenumberNoThe number of items per page.
parentIdstringNoParent Id
typestringNoThe type value

documenso_documents_folder_update_folder

Update folder Parameters:
ParameterTypeRequiredDefaultDescription
dataobjectYesThe data value
folderIdstringYesFolder Id

documenso_documents_recipient_create_document_recipient

Create document recipient Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
recipientobjectYesThe recipient value

documenso_documents_recipient_create_document_recipients

Create document recipients Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
recipientsobject[]YesThe recipients value

documenso_documents_recipient_delete_document_recipient

Delete document recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_documents_recipient_get_document_recipient

Get document recipient Parameters:
ParameterTypeRequiredDefaultDescription
recipientIdnumberYesRecipient Id

documenso_documents_recipient_update_document_recipient

Update document recipient Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
recipientobjectYesThe recipient value

documenso_documents_recipient_update_document_recipients

Update document recipients Parameters:
ParameterTypeRequiredDefaultDescription
documentIdnumberYesDocument Id
recipientsobject[]YesThe recipients value