List folders

GET

http://127.0.0.1:58931/api/folders

GET

/api/folders

$ curl -G http://127.0.0.1:58931/api/folders \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d page=1 \
>      -d page_size=20 \
>      -d keyword=

200Folders_List folders_example

1 {
2   "code": 0,
3   "data": {
4     "page": 1,
5     "folders": [
6       {
7         "name": "Project Documents",
8         "uuid": "a3f1c9e2-4b7d-4f8a-9c2e-1d2b3f4a5e6c"
9       },
10       {
11         "name": "Personal",
12         "uuid": "b7d2e4f9-8c3a-4d1b-9f7e-2a3c4d5e6f7b"
13       },
14       {
15         "name": "Invoices",
16         "uuid": "c9e3f5a7-6b8d-4c2f-9a1e-3b4d5f6a7c8e"
17       },
18       {
19         "name": "Archive",
20         "uuid": "d1f4a6b8-7c9e-4d3f-8b2a-4c5e6f7a8b9d"
21       },
22       {
23         "name": "Work",
24         "uuid": "e2a5b7c9-8d1f-4e3a-9c4b-5d6f7a8b9c0e"
25       }
26     ],
27     "page_size": 20,
28     "total_count": 5,
29     "total_pages": 1
30   },
31   "success": true
32 }

List folders.

Response data: { folders: [{ uuid, name }], page, page_size, total_count, total_pages }.

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

pageintegerOptional

number Default 1.

page_sizeintegerOptional

number Default 20.

keywordstringOptional

string Optional Search keyword.

Response

codeinteger

dataobject

successboolean