NetDocuments
App · 25 actions
Work with your firm's NetDocuments documents from a workflow: upload, search, file and version documents, manage folders and workspaces, add clients and matters, and start workflows when documents arrive.
Actions
| Action | What it does |
|---|---|
| Add document version | Add a new version to a document, from a file or by copying one of its versions. |
| Add or update lookup value | Add a value, such as a new client or matter, to a profile field's lookup table, or change the description of one that's there. |
| Check in document | Check a checked-out document back in, with its edited file if there is one. |
| Check out document | Check a document out to the connected user, so nobody else changes it until it is checked in. |
| Create folder | Create a folder at the top of a cabinet, or inside another folder. |
| Create secured link | Make a link anyone can open to view one document, and download it if allowed. |
| Delete document | Move a document to Deleted Items, or delete it for good. |
| Delete folder | Delete a folder. |
| Delete lookup value | Remove a value from a profile field's lookup table. |
| Download document | Save a document's official version to your files, so a later step can attach or upload it. |
| File document in folder | File a document in a folder, or take it out of one. |
| Find or create workspace | Get the workspace for a client (and matter) in a cabinet, creating it if it isn't there yet. |
| Get document | Get a document's profile: its name, type, size, versions, who changed it and when, and its profile values such as client and matter. |
| Get document history | List what has been done to a document, by whom and when. |
| Get lookup value | Get one value of a profile field's lookup table, such as a client. |
| Get my profile | Get the name, email and main cabinet of the connected NetDocuments user. |
| Get workspace | Get a workspace's details. |
| List cabinet folders | List the folders at the top of a cabinet. |
| List cabinets | List the cabinets the connected user can open, with the repository each belongs to. |
| List document versions | List every version of a document. |
| List folder contents | List the documents and subfolders in a folder. |
| Rename document | Give a document a new name. |
| Rename folder | Give a folder a new name. |
| Search documents | Search a cabinet for documents, with the same words and operators as NetDocuments' search box. |
| Upload document | Create a document in a folder or workspace from a file. |
Add document version
Add a new version to a document, from a file or by copying one of its versions. With neither, the official version is copied.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- File
filetext - The new version's file: upload one, pick one an earlier step made, or paste a public link. Leave empty to copy a version instead.
- Copy from version
copy_from_versionnumber - The number of the version to copy. Leave empty to copy the official version, or when giving a file.At least 1.
- Version name
version_nametext - A name for the new version.
- Description
descriptiontext - What changed in this version.
- Make official
make_officialtrue/false - On to make the new version the official one.
Outputs
document_idtext- The document
latest_versionnumber- The newest version's number
new_versionnumber- The new version's number
new_version_labeltext- The new version's label
official_versionnumber- The official version's number
official_version_nametext- The official version's name
Example output
{
"document_id": "4813-0021-9853",
"latest_version": 3,
"new_version": 3,
"new_version_label": "3",
"official_version": 3,
"official_version_name": "Signed"
}Add or update lookup value
Add a value, such as a new client or matter, to a profile field's lookup table, or change the description of one that's there.
Inputs
- Repository
repository_idtextRequired - The repository the profile field belongs to (its ID starts with CA-).
- Profile field number
attribute_numbernumberRequired - The number of the profile field whose lookup table to use, such as 1 for Client, as your cabinet's profile settings show it. 'List cabinets' gives the numbers of the fields a cabinet's workspaces use.At least 1.
- Value
keytextRequired - The value itself, such as a client or matter number.
- Description
descriptiontextRequired - What the value stands for, such as the client's or matter's name.
- Parent value
parent_keytext - For a child table such as Matter, the parent value it sits under, such as the client number. Leave empty for a table with no parent.
- Legal hold
holdtrue/false - On to put the value on legal hold.
Outputs
countnumber- How many entries NetDocuments changed
descriptiontext- Its description
keytext- The value
parent_keytext- The parent value, for a child table
savedtrue/false- True once saved
Example output
{
"count": 1,
"description": "Acme Corp",
"key": "1001",
"parent_key": "",
"saved": true
}Check in document
Check a checked-out document back in, with its edited file if there is one.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- File
filetext - The edited file: upload one, pick one an earlier step made, or paste a public link. Leave empty to check it in unchanged.
Outputs
checked_intrue/false- True once checked in
document_idtext- The document
new_contenttrue/false- True when a file was checked in with it
Example output
{
"checked_in": true,
"document_id": "4813-0021-9853",
"new_content": false
}Check out document
Check a document out to the connected user, so nobody else changes it until it is checked in.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- Comment
commenttext - Why it is checked out.
Outputs
checked_outtrue/false- True once checked out
commenttext- The comment given
document_idtext- The document
Example output
{
"checked_out": true,
"comment": "",
"document_id": "4813-0021-9853"
}Create folder
Create a folder at the top of a cabinet, or inside another folder.
Inputs
- Folder name
nametextRequired - The new folder's name.
- Cabinet
cabinet_idtext - The cabinet for a top-level folder. Leave empty when choosing a parent folder.
- Parent folder
parent_folder_idtext - The folder (or workspace) to put the new folder inside. Leave empty for a top-level folder in the cabinet.
Outputs
folderobject- The new folder
Example output
{
"folder": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:e:~200101120000002.nev",
"extension": "ndfld",
"id": "4834-5521-1170",
"kind": "folder",
"latest_version": 0,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Pleadings",
"profile": [],
"size": 0,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4834-5521-1170",
"version": 0
}
}Create secured link
Make a link anyone can open to view one document, and download it if allowed. Your cabinet's settings decide whether a password is required.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- Expires on
expiration_datedate - The last day the link works.
- Password
passwordtext - A password the person opening it must enter.
- Allow download
allow_downloadtrue/false - On to let them download it.
- Notify me
notify_metrue/false - On to be told by NetDocuments when the link is opened.
- Version
versionnumber - The version to share. Leave empty for the official version.At least 1.
Outputs
document_idtext- The shared document
download_urltext- The link to download it, when allowed
expiration_datetext- The last day the link works
view_urltext- The link to view it
Example output
{
"document_id": "4813-0021-9853",
"download_url": "https://vault.netvoyage.com/neWeb2/sl/AbC123?d=1",
"expiration_date": "2026-12-31",
"view_url": "https://vault.netvoyage.com/neWeb2/sl/AbC123"
}Delete document
Move a document to Deleted Items, or delete it for good.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- Delete for good
permanenttrue/false - On to delete it permanently instead of moving it to Deleted Items.
Outputs
deletedtrue/false- True once deleted
document_idtext- The deleted document
permanenttrue/false- True when it was deleted for good
Example output
{
"deleted": true,
"document_id": "4813-0021-9853",
"permanent": false
}Delete folder
Delete a folder. Its documents are taken out of it but kept, unless you choose to delete them too.
Inputs
- Folder
folder_idtextRequired - The folder. Pick a top-level folder, or give any folder's ID (such as 4813-0021-9853) from an earlier step.
- Delete its documents
delete_contentstrue/false - On to delete the documents in it (and in its subfolders) too.
- Delete for good
permanenttrue/false - On to delete the folder permanently instead of moving it to Deleted Items. Its documents are not deleted for good.
Outputs
contents_deletedtrue/false- True when its documents were deleted too
deletedtrue/false- True once deleted
folder_idtext- The deleted folder
permanenttrue/false- True when it was deleted for good
Example output
{
"contents_deleted": false,
"deleted": true,
"folder_id": "4834-5521-1170",
"permanent": false
}Delete lookup value
Remove a value from a profile field's lookup table.
Inputs
- Repository
repository_idtextRequired - The repository the profile field belongs to (its ID starts with CA-).
- Profile field number
attribute_numbernumberRequired - The number of the profile field whose lookup table to use, such as 1 for Client, as your cabinet's profile settings show it. 'List cabinets' gives the numbers of the fields a cabinet's workspaces use.At least 1.
- Value
keytextRequired - The value itself, such as a client or matter number.
- Parent value
parent_keytext - For a child table such as Matter, the parent value it sits under, such as the client number. Leave empty for a table with no parent.
Outputs
countnumber- How many entries NetDocuments removed
deletedtrue/false- True once removed
keytext- The value removed
parent_keytext- The parent value, for a child table
Example output
{
"count": 1,
"deleted": true,
"key": "1001",
"parent_key": ""
}Download document
Save a document's official version to your files, so a later step can attach or upload it.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
Outputs
content_typetext- The file's type
document_idtext- The document downloaded
document_reftext- The saved file, for steps that take a file
filenametext- The file's name
size_bytesnumber- The file's size in bytes
urltext- Where to open the saved file
Example output
{
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"document_id": "4813-0021-9853",
"document_ref": "doc_0123456789abcdef",
"filename": "Engagement letter.docx",
"size_bytes": 48213,
"url": "/actions/core/serve-document/doc_0123456789abcdef"
}File document in folder
File a document in a folder, or take it out of one. A document can sit in several folders at once.
Inputs
- Folder
folder_idtextRequired - The folder. Pick a top-level folder, or give any folder's ID (such as 4813-0021-9853) from an earlier step.
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- File or unfile
modetext - Whether to file the document in the folder or take it out.One of:
file(File it in the folder),unfile(Take it out of the folder). Default:file.
Outputs
document_idtext- The document
folder_idtext- The folder
modetext- file or unfile
Example output
{
"document_id": "4813-0021-9853",
"folder_id": "4834-5521-1170",
"mode": "file"
}Find or create workspace
Get the workspace for a client (and matter) in a cabinet, creating it if it isn't there yet. The client and matter must already be in their lookup tables.
Inputs
- Cabinet
cabinet_idtextRequired - The cabinet that holds the workspaces.
- Client
client_keytextRequired - The client value the workspace is for, such as client number 1001.
- Matter
matter_keytext - The matter value, such as 1001-0001, when the cabinet's workspaces are per matter. Leave empty when they are per client.
Outputs
workspaceobject- The workspace
Example output
{
"workspace": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:w:^W200101120000003.nev",
"extension": "ndws",
"id": ":Q12:a:b:c:w:^W200101120000003.nev",
"kind": "workspace",
"latest_version": 0,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Acme Corp - Acme v. Widget Co",
"profile": [],
"size": 0,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=W200101120000003",
"version": 0
}
}Get document
Get a document's profile: its name, type, size, versions, who changed it and when, and its profile values such as client and matter.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
Outputs
documentobject- The document
Example output
{
"document": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:d:~200101120000001.nev",
"extension": "docx",
"id": "4813-0021-9853",
"kind": "document",
"latest_version": 2,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Engagement letter",
"profile": [
{
"description": "Acme Corp",
"id": "1",
"value": "1001"
},
{
"description": "Acme v. Widget Co",
"id": "2",
"value": "1001-0001"
}
],
"size": 48213,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4813-0021-9853",
"version": 1
}
}Get document history
List what has been done to a document, by whom and when.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
Outputs
countnumber- How many are in this answer
document_idtext- The document
entrieslist- What was done
Example output
{
"count": 1,
"document_id": "4813-0021-9853",
"entries": [
{
"activity": "Edit",
"date": "2026-01-06T14:00:00Z",
"details": {
"activity": "Edit"
},
"user": "Ada Lovelace",
"version": "2"
}
]
}Get lookup value
Get one value of a profile field's lookup table, such as a client.
Inputs
- Repository
repository_idtextRequired - The repository the profile field belongs to (its ID starts with CA-).
- Profile field number
attribute_numbernumberRequired - The number of the profile field whose lookup table to use, such as 1 for Client, as your cabinet's profile settings show it. 'List cabinets' gives the numbers of the fields a cabinet's workspaces use.At least 1.
- Value
keytextRequired - The value itself, such as a client or matter number.
- Parent value
parent_keytext - For a child table such as Matter, the parent value it sits under, such as the client number. Leave empty for a table with no parent.
Outputs
entryobject- The lookup value
Example output
{
"entry": {
"closed": "",
"description": "Acme Corp",
"details": {
"description": "Acme Corp",
"key": "1001"
},
"hold": false,
"key": "1001",
"parent_key": ""
}
}Get my profile
Get the name, email and main cabinet of the connected NetDocuments user.
Inputs
None.
Outputs
userobject- The connected user
Example output
{
"user": {
"display_name": "Ada Lovelace",
"email": "ada@example.com",
"external": false,
"id": "DUCOT0123456789",
"is_repository_member": true,
"organization": "Lovelace & Babbage LLP",
"primary_cabinet": "NG-ABCD1234"
}
}Get workspace
Get a workspace's details.
Inputs
- Workspace ID
workspace_idtextRequired - The workspace's ID, from 'Find or create workspace' or an earlier step.
Outputs
workspaceobject- The workspace
Example output
{
"workspace": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:w:^W200101120000003.nev",
"extension": "ndws",
"id": ":Q12:a:b:c:w:^W200101120000003.nev",
"kind": "workspace",
"latest_version": 0,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Acme Corp - Acme v. Widget Co",
"profile": [],
"size": 0,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=W200101120000003",
"version": 0
}
}List cabinet folders
List the folders at the top of a cabinet.
Inputs
- Cabinet
cabinet_idtextRequired - The cabinet. Pick one, or give its ID (it starts with NG-).
Outputs
cabinet_idtext- The cabinet
countnumber- How many are in this answer
folderslist- The folders
Example output
{
"cabinet_id": "NG-ABCD1234",
"count": 1,
"folders": [
{
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:e:~200101120000002.nev",
"extension": "ndfld",
"id": "4834-5521-1170",
"kind": "folder",
"latest_version": 0,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Pleadings",
"profile": [],
"size": 0,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4834-5521-1170",
"version": 0
}
]
}List cabinets
List the cabinets the connected user can open, with the repository each belongs to.
Inputs
None.
Outputs
cabinetslist- The cabinets
countnumber- How many are in this answer
Example output
{
"cabinets": [
{
"id": "NG-ABCD1234",
"name": "Litigation",
"repository_id": "CA-WXYZ5678",
"repository_name": "Lovelace & Babbage",
"workspace_attribute_number": 2,
"workspace_parent_attribute_number": 1
}
],
"count": 1
}List document versions
List every version of a document.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
Outputs
countnumber- How many are in this answer
document_idtext- The document
versionslist- The versions
Example output
{
"count": 1,
"document_id": "4813-0021-9853",
"versions": [
{
"description": "Comments from the client",
"details": {
"name": "Client comments",
"number": 2
},
"extension": "docx",
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Client comments",
"number": 2,
"official": true,
"size": 49002
}
]
}List folder contents
List the documents and subfolders in a folder.
Inputs
- Folder
folder_idtextRequired - The folder. Pick a top-level folder, or give any folder's ID (such as 4813-0021-9853) from an earlier step.
Outputs
countnumber- How many are in this answer
document_countnumber- How many are documents
folder_countnumber- How many are folders
folder_idtext- The folder listed
itemslist- The documents and folders
Example output
{
"count": 2,
"document_count": 1,
"folder_count": 1,
"folder_id": "4834-5521-1170",
"items": [
{
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:d:~200101120000001.nev",
"extension": "docx",
"id": "4813-0021-9853",
"kind": "document",
"latest_version": 2,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Engagement letter",
"profile": [
{
"description": "Acme Corp",
"id": "1",
"value": "1001"
},
{
"description": "Acme v. Widget Co",
"id": "2",
"value": "1001-0001"
}
],
"size": 48213,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4813-0021-9853",
"version": 1
},
{
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:e:~200101120000002.nev",
"extension": "ndfld",
"id": "4834-5521-1170",
"kind": "folder",
"latest_version": 0,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Pleadings",
"profile": [],
"size": 0,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4834-5521-1170",
"version": 0
}
]
}Rename document
Give a document a new name.
Inputs
- Document ID
document_idtextRequired - The document's ID, such as 4813-0021-9853, from a trigger, a search or an earlier step.
- New name
nametextRequired - The document's new name.
Outputs
documentobject- The document
Example output
{
"document": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:d:~200101120000001.nev",
"extension": "docx",
"id": "4813-0021-9853",
"kind": "document",
"latest_version": 2,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Engagement letter",
"profile": [
{
"description": "Acme Corp",
"id": "1",
"value": "1001"
},
{
"description": "Acme v. Widget Co",
"id": "2",
"value": "1001-0001"
}
],
"size": 48213,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4813-0021-9853",
"version": 1
}
}Rename folder
Give a folder a new name.
Inputs
- Folder
folder_idtextRequired - The folder. Pick a top-level folder, or give any folder's ID (such as 4813-0021-9853) from an earlier step.
- New name
nametextRequired - The folder's new name.
Outputs
folder_idtext- The folder
nametext- Its new name
renamedtrue/false- True once renamed
Example output
{
"folder_id": "4834-5521-1170",
"name": "Pleadings 2026",
"renamed": true
}Search documents
Search a cabinet for documents, with the same words and operators as NetDocuments' search box.
Inputs
- Cabinet
cabinet_idtextRequired - The cabinet. Pick one, or give its ID (it starts with NG-).
- Search for
querytextRequired - What to search for, such as engagement letter or a client number. NetDocuments' search operators work too.
- Order
order_bytext - How to order the results.One of:
relevance desc(Most relevant first (default)),lastMod desc(Most recently changed first),lastMod asc(Least recently changed first),name asc(Name, A to Z),name desc(Name, Z to A). Default:relevance desc. - Most results
limitnumber - How many results to return, 1 to 500. The default is 100.From 1 to 500. Default:
100.
Outputs
cabinet_idtext- The cabinet searched
countnumber- How many are in this answer
documentslist- The documents found
Example output
{
"cabinet_id": "NG-ABCD1234",
"count": 1,
"documents": [
{
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:d:~200101120000001.nev",
"extension": "docx",
"id": "4813-0021-9853",
"kind": "document",
"latest_version": 2,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Engagement letter",
"profile": [
{
"description": "Acme Corp",
"id": "1",
"value": "1001"
},
{
"description": "Acme v. Widget Co",
"id": "2",
"value": "1001-0001"
}
],
"size": 48213,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4813-0021-9853",
"version": 1
}
]
}Upload document
Create a document in a folder or workspace from a file.
Inputs
- Folder
folder_idtextRequired - Where to put the document: a folder, or a workspace's ID. Pick a top-level folder, or give an ID from an earlier step.
- File
filetextRequired - The file: upload one, pick one an earlier step made, or paste a public link to one.
- Document name
nametext - The document's name. Leave empty to use the file's name.
Outputs
documentobject- The new document
folder_idtext- Where it was put
Example output
{
"document": {
"cabinet_id": "NG-ABCD1234",
"checked_out": false,
"checked_out_by": "",
"created": "2026-01-05T09:30:00Z",
"created_by": "Ada Lovelace",
"env_id": ":Q12:a:b:c:d:~200101120000001.nev",
"extension": "docx",
"id": "4813-0021-9853",
"kind": "document",
"latest_version": 2,
"locked": false,
"modified": "2026-01-06T14:00:00Z",
"modified_by": "Ada Lovelace",
"name": "Engagement letter",
"profile": [
{
"description": "Acme Corp",
"id": "1",
"value": "1001"
},
{
"description": "Acme v. Widget Co",
"id": "2",
"value": "1001-0001"
}
],
"size": 48213,
"url": "https://vault.netvoyage.com/neWeb2/goId.aspx?id=4813-0021-9853",
"version": 1
},
"folder_id": "4834-5521-1170"
}