Folders - API Documentation

Retrieve all

Endpoint

GET https://leads.qreq.com/api/document-folders

Example

curl --request GET \
--url 'https://leads.qreq.com/api/document-folders' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Document folders retrieved successfully.", "data": [ { "id": 1, "name": "Contracts", "parent_id": null, "description": "Client contracts and agreements", "documents_count": 12, "created_by": 33, "created_at": "2025-11-03T08:00:00.000000Z", "updated_at": "2025-11-03T08:00:00.000000Z" }, { "id": 2, "name": "Invoices", "parent_id": 1, "description": null, "documents_count": 5, "created_by": 33, "created_at": "2025-11-03T08:10:00.000000Z", "updated_at": "2025-11-03T08:10:00.000000Z" } ] }

Show

Endpoint

GET https://leads.qreq.com/api/document-folders/{folder_id}

Example

curl --request GET \
--url 'https://leads.qreq.com/api/document-folders/{folder_id}' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Document folder retrieved successfully.", "data": { "id": 1, "name": "Contracts", "parent_id": null, "description": "Client contracts and agreements", "documents_count": 12, "documents": [ { "id": 101, "name": "Contract - Company A.pdf", "file_url": "https://cdn.example.com/files/contract_company_a.pdf", "size": 245760, "uploaded_by": 33, "uploaded_at": "2025-11-03T08:05:00.000000Z" } ], "created_by": 33, "created_at": "2025-11-03T08:00:00.000000Z", "updated_at": "2025-11-03T08:00:00.000000Z" } }

Create

Endpoint

POST https://leads.qreq.com/api/document-folders

Parameters	Details	Description
name	RequiredString	Folder name
parent_id	OptionalInteger	Parent folder ID (for nested folders)
description	OptionalString	Folder description
permissions	OptionalArray	Array of permission rules (e.g. [{"user_id":5,"access":"read"}])

Example

curl --request POST \
--url 'https://leads.qreq.com/api/document-folders' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "New Folder", "parent_id": null, "description": "Folder for Q4 proposals", "permissions": [ {"user_id": 5, "access": "read"}, {"user_id": 6, "access": "write"} ] }'

Response example

{ "status": "success", "message": "Document folder created successfully.", "data": { "id": 10, "name": "New Folder", "parent_id": null, "description": "Folder for Q4 proposals", "documents_count": 0, "created_by": 33, "created_at": "2025-11-03T09:00:00.000000Z", "updated_at": "2025-11-03T09:00:00.000000Z" } }

Update

Endpoint

PUT https://leads.qreq.com/api/document-folders/{folder_id}

Example

curl --request PUT \
--url 'https://leads.qreq.com/api/document-folders/{folder_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{ "name": "Renamed Folder", "description": "Updated description" }'

Response example

{ "status": "success", "message": "Document folder updated successfully.", "data": { "id": 10, "name": "Renamed Folder", "description": "Updated description", "updated_at": "2025-11-03T09:10:00.000000Z" } }

Delete

Endpoint

DELETE https://leads.qreq.com/api/document-folders/{folder_id}

Example

curl --request DELETE \
--url 'https://leads.qreq.com/api/document-folders/{folder_id}' \
--header 'Authorization: Bearer {api_key}'

Response example

{ "status": "success", "message": "Document folder deleted successfully." }