Actions41
- ASN Actions
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Note Actions
- Document Type Actions
- Storage Path Actions
- Tag Actions
- Task Actions
Correspondent → Get a Correspondent
AI-generatedSummary
Retrieves a single Correspondent object from Paperless-ngx using either a direct ID or a value selected from a list of existing Correspondents.
Inputs
- id (required) — The numeric ID of the Correspondent to retrieve. Must be a positive integer. Alternatively, select 'From List' to pick from a searchable list of existing Correspondents.
Output shape
a single item containing the Correspondent object
The returned item includes the full Correspondent object with all metadata fields.
Examples
Example 1: Retrieve a specific correspondent by ID
Set 'By ID' mode and enter the numeric ID (e.g., 5).
Example 2: Select a correspondent from an existing list
Set 'From List' mode and select a correspondent from the searchable list.