Viridem icon

Viridem

Interact's with Viridem

Actions77

Document Anchors → List Document Anchor

AI-generated

Overview

This node operation lists document anchors based on specified search criteria within a company. It supports keyword searches, pagination, sorting by newest first, and advanced search options including filtering by template ID, template type ID, and specific field IDs. This operation is useful for retrieving specific document anchor data from a document management or indexing system, enabling users to find relevant document anchors efficiently.

Use Case Examples

  1. Retrieve document anchors containing specific keywords for a given company.
  2. Perform an advanced search for document anchors filtered by template ID and field IDs.
  3. Paginate through document anchors with control over items per page and sorting order.

Properties

Name Meaning
Company Id The identifier of the company to which the document anchors belong.
Keywords Keywords to search for within the document anchors.
Page The page number of the results to retrieve for pagination.
Per Page Number of document anchors to retrieve per page.
Newest First Boolean flag to sort results with the newest document anchors first.
Advanced Search Flag to specify whether to perform an advanced search.
Template Id (AdvancedSearch) Template ID to filter document anchors, required if no keywords or template type ID are provided.
Template Type Id (AdvancedSearch) Template type ID to filter document anchors, required if no keywords or template ID are provided.
Field Ids (AdvancedSearch) List of global field IDs to restrict keyword search to specific fields.
Exact Word (AdvancedSearch) Boolean flag to search for exact word matches only.

Output

JSON

  • documentAnchors - Array of document anchor objects matching the search criteria.

Dependencies

  • An API key credential for authentication with the Viridem API

Troubleshooting

  • Ensure the Company Id is correctly specified and exists in the system to avoid empty results.
  • If using advanced search, provide either keywords or template/template type IDs as required to avoid errors.
  • Check network connectivity and API base URL configuration if requests fail.
  • Verify that pagination parameters (page, per_page) are within valid ranges to avoid unexpected results.

Discussion