List custom fields
list_custom_fieldsList custom fields defined in a paperless-ngx archive, optionally filtered by IDs or name, to find field IDs used for document values and search queries.
Instructions
List the custom fields defined in the archive.
get_document returns a document's custom field values by field ID. A select field's value is the id of one of the field's select_options. Search custom field values with search_documents, using a query like "custom_fields.value:overdue".
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_custom_fields"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Return only the custom fields with these IDs (default: none) | |
| page | No | Page number, starting at 1 (default: 1) | |
| page_size | No | Number of custom fields per page (default: 100) | |
| name_contains | No | Case-insensitive substring of the name (default: none) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pagination | Yes | The position of one page of results in the full result set. | |
| custom_fields | Yes |