Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• id string

  Document ID filter.
  
  When tags and/or contact are specified, id is generated automatically based on the documents found and any value provided here is ignored. If no matching documents are found, id is set to -1.
  
  When neither tags nor contact is specified, the provided id value is used for filtering.
  
  Multi-value supported. Example: value1;value2
  
  

• date string

  Document date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• name string

  Document name filter

• tags string

  Document tag ID.
  
  Multi-value supported. Example: value1;value2
  
  

• contact string

  Contact ID.
  
  Multi-value supported. Example: value1;value2
  
  

• module string

  Module the document belongs to

  Values are CONTACTS, STOCK_MOVEMENTS, JOURNAL, ORGANIZATIONS, PURCHASE_INVOICES, SALARIES, SALES_INVOICES, ORDERS, or UNASSIGNED.

• fileName string

  Original file name filter

• fileExtension string

  File extension filter

• size integer(int64)

  File size in bytes filter

• createdOn string

  Upload date filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • 01/01/2026..31/12/2026
  • >=01/01/2026
  • <=01/01/2026
  • <>01/01/2026

  Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
  
  

• createdBy string

  Name of the user who uploaded the document

• creatorId string

  Contact ID of the user who uploaded the document.
  
  Multi-value supported. Example: value1;value2
  
  

• isDeleted boolean

  Whether the document is marked as deleted

• filterNotAssignDocuments boolean

  Whether to filter for documents in the Document Scan window that are not assigned to any module or contact, based on the current filters and permissions

Responses

• 200 application/json

  OK
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error