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

• sortingField string

  Field to sort by

• direction string

  Sorting direction

  Value is ASC,DESC.

• pageNumber integer

  Page Number

• sizePerPage integer

  Size per page

  Default value is 60.

• id string

  Document identifier(s). When filteredTags and/or filteredContacts are specified, the value of id is generated automatically based on the documents found and any user-provided id value is ignored. If no matching documents are found, id is set to -1. When neither filteredTags nor filteredContacts is specified, the id value provided in the request is used for filtering.
  
  Multi-value supported. Example: value1;value2
  
  

• date string

  Date of the documentSupports 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

  Name of the document

• module string

  Type of module for the document

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

• fileId integer(int64)

  File ID related to the document

• fileName string

  Name of the file related to the document

• fileExtension string

  Extension of the file related to the document

• size integer(int64)

  Size of the document file

• createdOn string

  Document creation dateSupports 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

  User who has created the document

• creatorId string

  Creator contact ID of the document
  
  Multi-value supported. Example: value1;value2
  
  

• self boolean

  Boolean flag about whetehr the document was deleted or not

• tags string

  Semicolon-separated list of tag IDs. Multi-value supported. Example: value1;value2

• contact string

  Semicolon-separated list of contact IDs. Multi-value supported. Example: value1;value2

• filterStaffDocuments boolean

  Checks whether documents should be filtered based on parameters and corresponding 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