Files Filter Options

GET /desktop/files/filter-options

This endpoint retrieves filter options for files in the system. It provides various parameters that can be utilized to refine file searches, such as tags, file types, users, and date options.

Request Parameters

This is a GET request and does not require any specific parameters in the query string.

Response Structure

The response will return a JSON object containing the following fields:

success (boolean): Indicates whether the request was successful.

message (string): A message providing additional information about the request.

data (object): Contains the following properties:

tags (array of strings): An array of available tags for filtering files.

fileTypes (array of strings): An array of supported file types.

users (array of objects): A list of users, where each user object contains:

id (string): The unique identifier of the user.

name (string): The name of the user.

dateOptions (array of strings): An array of options for date filtering.

Example Response

{
  "success": true,
  "message": "",
  "data": {
    "tags": [""],
    "fileTypes": [""],
    "users": [{"id": "", "name": ""}],
    "dateOptions": [""]
  }
}

This endpoint is particularly useful for retrieving filter options when searching for PDF files tagged as "RECEIPT" uploaded by the user within the last 30 days, specifically targeting invoices.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "success": true, "message": "File filter options fetched successfully", "data": { "tags": [ "DOCUMENT", "EXPENSE" ], "fileTypes": [ "image" ], "users": [ { "id": "2279", "name": "Adeleke Michael" } ], "dateOptions": [ "last_30_days", "last_6_months", "this_year", "last_year" ] } }

Files Filter Options

GET /desktop/files/filter-options#

Request Parameters#

Response Structure#

Example Response#

Request

Responses

GET /desktop/files/filter-options

Request Parameters

Response Structure

Example Response