> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# netdocuments-documents

> NetDocuments Documents - manage documents, folders, and search cabinets

**Server path:** `/netdocuments-documents` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                              | Description                       |
| ------------------------------------------------------------------------------------------------- | --------------------------------- |
| [`netdocuments_documents_check_out_doc`](#netdocuments_documents_check_out_doc)                   | Check out document                |
| [`netdocuments_documents_create_folder`](#netdocuments_documents_create_folder)                   | Create folder                     |
| [`netdocuments_documents_create_secured_link`](#netdocuments_documents_create_secured_link)       | Create secured link               |
| [`netdocuments_documents_delete_doc`](#netdocuments_documents_delete_doc)                         | Delete document                   |
| [`netdocuments_documents_delete_folder`](#netdocuments_documents_delete_folder)                   | Delete folder                     |
| [`netdocuments_documents_file_folder`](#netdocuments_documents_file_folder)                       | File or unfile document to folder |
| [`netdocuments_documents_follow_document`](#netdocuments_documents_follow_document)               | Follow document                   |
| [`netdocuments_documents_follow_folder`](#netdocuments_documents_follow_folder)                   | Follow folder                     |
| [`netdocuments_documents_get_container_contents`](#netdocuments_documents_get_container_contents) | Get container contents            |
| [`netdocuments_documents_get_doc_history`](#netdocuments_documents_get_doc_history)               | Document history                  |
| [`netdocuments_documents_get_doc_info`](#netdocuments_documents_get_doc_info)                     | Get document profile              |
| [`netdocuments_documents_get_document_versions`](#netdocuments_documents_get_document_versions)   | Get document versions             |
| [`netdocuments_documents_get_fld_content`](#netdocuments_documents_get_fld_content)               | Get folder items                  |
| [`netdocuments_documents_lock_document`](#netdocuments_documents_lock_document)                   | Lock document                     |
| [`netdocuments_documents_rename_document`](#netdocuments_documents_rename_document)               | Rename document                   |
| [`netdocuments_documents_rename_folder`](#netdocuments_documents_rename_folder)                   | Rename folder                     |
| [`netdocuments_documents_search_cabinets`](#netdocuments_documents_search_cabinets)               | Search one or more cabinets       |
| [`netdocuments_documents_unock_document`](#netdocuments_documents_unock_document)                 | Unlock document                   |

***

## netdocuments\_documents\_check\_out\_doc

Check out document

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------ |
| `id`          | string  | Yes      | —       | 12-digit document ID.                                                                      |
| `comment`     | string  | No       | —       | The comment value                                                                          |
| `download`    | boolean | No       | —       | Returns the document content.                                                              |
| `version`     | string  | No       | —       | Specifies which version’s content should be downloaded.  Defaults to the official version. |
| `addToRecent` | boolean | No       | —       | Add to recent                                                                              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "comment": {
        "type": "string",
        "description": "The comment value"
      },
      "download": {
        "type": "boolean",
        "description": "Returns the document content."
      },
      "version": {
        "type": "string",
        "description": "Specifies which version’s content should be downloaded.  Defaults to the official version."
      },
      "addToRecent": {
        "type": "boolean",
        "description": "Add to recent"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_create\_folder

Create folder

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                                                                    |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `name`         | string  | Yes      | —       | Folder name.                                                                                   |
| `sanitizeName` | boolean | Yes      | —       | If true, invalid characters in the name parameter are removed without an error being returned. |
| `parent`       | string  | No       | —       | 12-digit ID or EnvID of the new folder’s parent container.                                     |
| `cabinet`      | string  | No       | —       | (It starts with NG-) Can be omitted if a folder or workspace id is specified in the parent.    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Folder name."
      },
      "sanitizeName": {
        "type": "boolean",
        "description": "If true, invalid characters in the name parameter are removed without an error being returned."
      },
      "parent": {
        "type": "string",
        "description": "12-digit ID or EnvID of the new folder’s parent container."
      },
      "cabinet": {
        "type": "string",
        "description": "(It starts with NG-) Can be omitted if a folder or workspace id is specified in the parent."
      }
    },
    "required": [
      "PCID",
      "name",
      "sanitizeName"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_create\_secured\_link

Create secured link

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                             |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------- |
| `id`             | string  | Yes      | —       | 12-digit document ID.                                                                   |
| `password`       | string  | No       | —       | Depending on the cabinet configuration, the password may be optional or mandatory.      |
| `expirationdate` | string  | No       | —       | Input format: yyyy-MM-dd.                                                               |
| `version`        | string  | No       | —       | Which version of the document to share.  If empty, the official version will be shared. |
| `download`       | boolean | No       | —       | If true, the document may be downloaded by the recipient.                               |
| `notifyme`       | boolean | No       | —       | If true, notify the sender when the secured link is accessed.                           |
| `lock`           | boolean | No       | —       | Optionally, lock the selected version of the document.  This requires Edit rights.      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "password": {
        "type": "string",
        "description": "Depending on the cabinet configuration, the password may be optional or mandatory."
      },
      "expirationdate": {
        "type": "string",
        "description": "Input format: yyyy-MM-dd."
      },
      "version": {
        "type": "string",
        "description": "Which version of the document to share.  If empty, the official version will be shared."
      },
      "download": {
        "type": "boolean",
        "description": "If true, the document may be downloaded by the recipient."
      },
      "notifyme": {
        "type": "boolean",
        "description": "If true, notify the sender when the secured link is accessed."
      },
      "lock": {
        "type": "boolean",
        "description": "Optionally, lock the selected version of the document.  This requires Edit rights."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_delete\_doc

Delete document

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                                                                    |
| ----------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
| `id`        | string  | Yes      | —       | 12-digit document ID.                                                                          |
| `permanent` | boolean | No       | —       | Indicates that the document should be permanently deleted, rather than moved to Deleted Items. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "permanent": {
        "type": "boolean",
        "description": "Indicates that the document should be permanently deleted, rather than moved to Deleted Items."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_delete\_folder

Delete folder

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                                                                                                                |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`             | string  | Yes      | —       | 12-digit Folder ID.                                                                                                                                                                        |
| `permanent`      | boolean | No       | —       | Indicates that the folder should be permanently deleted, rather than moved to Deleted Items. The contents of the folder, including descendant subfolders, will not be permanently deleted. |
| `deleteContents` | boolean | No       | —       | Indicates that the documents in the deleted folder (and in any descendant subfolder) should be deleted also, rather than simply unfiled.                                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit Folder ID."
      },
      "permanent": {
        "type": "boolean",
        "description": "Indicates that the folder should be permanently deleted, rather than moved to Deleted Items. The contents of the folder, including descendant subfolders, will not be permanently deleted."
      },
      "deleteContents": {
        "type": "boolean",
        "description": "Indicates that the documents in the deleted folder (and in any descendant subfolder) should be deleted also, rather than simply unfiled."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_file\_folder

File or unfile document to folder

**Parameters:**

| Parameter | Type   | Required | Default | Description           |
| --------- | ------ | -------- | ------- | --------------------- |
| `id`      | string | Yes      | —       | 12-digit folder ID.   |
| `item`    | string | Yes      | —       | 12-digit document ID. |
| `action`  | string | Yes      | —       | File or unfile        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit folder ID."
      },
      "item": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "action": {
        "type": "string",
        "description": "File or unfile",
        "enum": [
          "file",
          "unfile"
        ]
      }
    },
    "required": [
      "PCID",
      "id",
      "item",
      "action"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_follow\_document

Follow document

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                                      |
| ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------- |
| `id`         | string | Yes      | —       | 12-digit document ID.                                                            |
| `recipients` | string | Yes      | —       | One or more valid email addresses separated by semi-colons.  Duplicates ignored. |
| `send`       | string | No       | —       | Which category of users should receive the alert.                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "recipients": {
        "type": "string",
        "description": "One or more valid email addresses separated by semi-colons.  Duplicates ignored."
      },
      "send": {
        "type": "string",
        "description": "Which category of users should receive the alert.",
        "enum": [
          "ignoreGenerator",
          "ignoreCreator",
          "always"
        ]
      }
    },
    "required": [
      "PCID",
      "id",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_follow\_folder

Follow folder

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                                      |
| ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------- |
| `id`         | string | Yes      | —       | 12-digit folder ID.                                                              |
| `recipients` | string | Yes      | —       | One or more valid email addresses separated by semi-colons.  Duplicates ignored. |
| `send`       | string | No       | —       | Which category of users should receive the alert.                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit folder ID."
      },
      "recipients": {
        "type": "string",
        "description": "One or more valid email addresses separated by semi-colons.  Duplicates ignored."
      },
      "send": {
        "type": "string",
        "description": "Which category of users should receive the alert.",
        "enum": [
          "ignoreGenerator",
          "ignoreCreator",
          "always"
        ]
      }
    },
    "required": [
      "PCID",
      "id",
      "recipients"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_get\_container\_contents

Get container contents

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                      |
| ------------- | ------- | -------- | ------- | ------------------------------------------------ |
| `containerID` | string  | Yes      | —       | Container ID                                     |
| `select`      | string  | Yes      | —       | (Review the documentation for the return format) |
| `top`         | integer | No       | —       | (Maximum 500 per page)                           |
| `skiptoken`   | string  | No       | —       | Token used for paginating results                |
| `orderby`     | string  | No       | —       | (Format:  field#\|desc or field#\|asc)           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "containerID": {
        "type": "string",
        "description": "Container ID"
      },
      "select": {
        "type": "string",
        "description": "(Review the documentation for the return format)"
      },
      "top": {
        "type": "integer",
        "description": "(Maximum 500 per page)"
      },
      "skiptoken": {
        "type": "string",
        "description": "Token used for paginating results"
      },
      "orderby": {
        "type": "string",
        "description": "(Format:  field#|desc or field#|asc)"
      }
    },
    "required": [
      "PCID",
      "containerID",
      "select"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_get\_doc\_history

Document history

**Parameters:**

| Parameter | Type   | Required | Default | Description           |
| --------- | ------ | -------- | ------- | --------------------- |
| `id`      | string | Yes      | —       | 12-digit document ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_get\_doc\_info

Get document profile

**Parameters:**

| Parameter | Type   | Required | Default | Description           |
| --------- | ------ | -------- | ------- | --------------------- |
| `id`      | string | Yes      | —       | 12-digit document ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_get\_document\_versions

Get document versions

**Parameters:**

| Parameter    | Type   | Required | Default | Description           |
| ------------ | ------ | -------- | ------- | --------------------- |
| `documentID` | string | Yes      | —       | 12-digit document ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "documentID": {
        "type": "string",
        "description": "12-digit document ID."
      }
    },
    "required": [
      "PCID",
      "documentID"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_get\_fld\_content

Get folder items

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                  |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------- |
| `id`      | string | Yes      | —       | 12-digit folder ID.                                                                          |
| `$select` | string | No       | —       | A comma-separated list of attribute values. See the REST API documentation for more details. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit folder ID."
      },
      "$select": {
        "type": "string",
        "description": "A comma-separated list of attribute values. See the REST API documentation for more details."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_lock\_document

Lock document

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `id`      | string | Yes      | —       | Document iD       |
| `comment` | string | No       | —       | The comment value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "Document iD"
      },
      "comment": {
        "type": "string",
        "description": "The comment value"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_rename\_document

Rename document

**Parameters:**

| Parameter            | Type   | Required | Default | Description           |
| -------------------- | ------ | -------- | ------- | --------------------- |
| `id`                 | string | Yes      | —       | 12-digit document ID. |
| `standardAttributes` | object | No       | —       | Standard Attributes   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit document ID."
      },
      "standardAttributes": {
        "type": "object",
        "description": "Standard Attributes",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name value"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_rename\_folder

Rename folder

**Parameters:**

| Parameter            | Type   | Required | Default | Description         |
| -------------------- | ------ | -------- | ------- | ------------------- |
| `id`                 | string | Yes      | —       | 12-digit folder ID. |
| `standardAttributes` | object | No       | —       | Standard Attributes |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "12-digit folder ID."
      },
      "standardAttributes": {
        "type": "object",
        "description": "Standard Attributes",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name value"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_search\_cabinets

Search one or more cabinets

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                      |
| ----------- | ------- | -------- | ------- | ------------------------------------------------ |
| `cabinets`  | string  | Yes      | —       | (comma-delimited)                                |
| `q`         | string  | Yes      | —       | (Review the documentation for the query format)  |
| `select`    | string  | Yes      | —       | (Review the documentation for the return format) |
| `orderby`   | string  | No       | —       | (Format:  field#\|desc or field#\|asc)           |
| `top`       | integer | No       | —       | (Maximum 500 per page)                           |
| `skip`      | integer | No       | —       | Number of results to skip                        |
| `skiptoken` | string  | No       | —       | Token used for paginating results                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cabinets": {
        "type": "string",
        "description": "(comma-delimited)"
      },
      "q": {
        "type": "string",
        "description": "(Review the documentation for the query format)"
      },
      "select": {
        "type": "string",
        "description": "(Review the documentation for the return format)"
      },
      "orderby": {
        "type": "string",
        "description": "(Format:  field#|desc or field#|asc)"
      },
      "top": {
        "type": "integer",
        "description": "(Maximum 500 per page)"
      },
      "skip": {
        "type": "integer",
        "description": "Number of results to skip"
      },
      "skiptoken": {
        "type": "string",
        "description": "Token used for paginating results"
      }
    },
    "required": [
      "PCID",
      "cabinets",
      "q",
      "select"
    ]
  }
  ```
</Expandable>

***

## netdocuments\_documents\_unock\_document

Unlock document

**Parameters:**

| Parameter | Type   | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------- |
| `id`      | string | Yes      | —       | Document ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "Document ID"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>