Viridem icon

Viridem

Interact's with Viridem

Actions77

Document Anchors → List Basket Document Anchor

AI-generated

Overview

This node operation lists basket document anchors for a specified company. It supports pagination, filtering by keywords, assigned user, and sorting by newest first. Users can specify which fields to return in the response. This operation is useful for retrieving and managing document anchors within a company's basket, such as for document tracking or review workflows.

Use Case Examples

  1. Retrieve the first page of document anchors for company ID 123, showing 15 items per page, sorted by newest first.
  2. Filter document anchors assigned to a specific user and containing certain keywords.
  3. Customize the response to include only specific fields of the document anchors.

Properties

Name Meaning
Company Id The ID of the company to list document anchors for.
Page The page number of results to retrieve for pagination.
Per Page The number of document anchors to return per page.
Keywords Keywords to filter the document anchors by.
Assigned User Id Filter to return only document anchors assigned to this user.
Newest First Whether to sort the results with the newest document anchors first.
Fields To Return The specific fields (by ID) to include in the response for each document anchor.

Output

JSON

  • documentAnchors - Array of document anchor objects returned from the list operation.

Dependencies

  • An API key credential for Viridem OAuth2 API

Troubleshooting

  • Ensure the Company Id is valid and accessible with the provided credentials.
  • Check pagination parameters (Page and Per Page) to avoid empty or incomplete results.
  • Verify that the assigned user ID exists and has document anchors assigned if filtering by user.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings.

Links

Discussion