Autentique icon

Autentique

Trabalhe com dados da API do Autentique para assinaturas digitais

Actions22

Document → Search

AI-generated

Overview

This node operation allows users to search for documents within the Autentique platform using advanced filters. It supports filtering by search term in the document name, document status, folder ID, and allows pagination and sorting of results. This is useful for scenarios where users need to find specific documents based on various criteria, such as status or folder location, and manage large sets of documents efficiently.

Use Case Examples

  1. Search for all signed documents containing 'Contract' in their name within a specific folder.
  2. Retrieve the first 50 documents sorted by creation date in descending order.
  3. Filter documents that are pending signature and order them by name ascending.

Properties

Name Meaning
Limit Maximum number of results to return in the search query.
Page Page number of the search results to retrieve.
Search Term Term to search for in the document name.
Document Status Filter documents by their status (e.g., All, Deleted, Not Signed, Pending, Rejected, Signed).
Search Folder ID ID of the folder to filter documents by (optional).
Order By Field to order the search results by (Created At, Updated At, Name).
Order Direction Direction of the ordering (Descending or Ascending).

Output

JSON

  • data
    • documents
      * data - Array of document objects matching the search criteria, each containing details like id, name, status flags, creation and update timestamps, and signature information.
      * total - Total number of documents matching the search criteria.
      * per_page - Number of documents returned per page.
      * current_page - Current page number of the results.
      * last_page - Last page number available for the results.

Dependencies

  • Autentique API with an API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has permissions to access document data.
  • Verify that the folder ID used for filtering exists and is accessible.
  • Check that the search term and status values are valid and correctly formatted.
  • If no results are returned, try adjusting the limit, page, or filters to broaden the search.

Links

Discussion