--- title: "Get all folders" url: "https://docs.signnow.com/docs/folder/operations/get-all-folders" type: "endpoint" section: "folder" slug: "folder/operations/get-all-folders" method: "GET" path: "/user/folder" operation_id: "get-all-folders" authorization: "bearer" --- # Get all folders `GET /user/folder` This endpoint allows API users to get the root folder of the user and its top-level folders, including the system folders (`Documents`, `Archive`, `Templates`, `Trash Bin`) and team folders. **Notes** * The same operation is also available at `GET /folder`. * `document_count` and `template_count` depend on `entity_type`. By default (`document-all`), a folder counts only documents or only templates, depending on the folder type. * To get the contents of a specific folder, call `GET /folder/{folder_id}`. ## Authorization bearer ## Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `filters` | string | No | Filter to apply to the document list. Possible values: `signing-status`, `documents-created`, `documents-updated`. Set the filter value in `filter-values`. | | `filter-values` | string | No | Value for the filter set in `filters`. For `signing-status`: `signed`, `pending`, `waiting-for-me`, `waiting-for-others`, `unsent`. For `documents-created` and `documents-updated`: a Unix timestamp; documents created or updated from that time are returned. Date filters do not apply to templates. | | `sortby` | string | No | Field to sort documents by. Possible values: `created`, `updated`, `recently_used`. `recently_used` sorts templates by the date the last invite was sent and applies to `Templates` folders. | | `order` | string | No | Sort order. Can be used only with `sortby`. Possible values: `desc`, `asc`. Default: `desc`. | | `limit` | integer | No | Maximum number of documents to return. Max: `100`. Larger values are reduced to `100`. | | `offset` | integer | No | Number of documents to skip before the returned page starts. | | `subfolder-data` | string | No | Whether to include subfolders in the response. Possible values: `1`, `0`. Must be used with `include_documents_subfolders`. | | `include_documents_subfolders` | string | No | Whether to include subfolders in the response. Possible values: `1`, `0`. Must be used with `subfolder-data`. | | `with_team_documents` | string | No | Whether to include `Team Documents` folders. Possible values: `true`, `false`. | | `only_favorites` | string | No | Whether to return only favorite documents and document groups. Possible values: `true`, `false`. Default: `false`. | | `entity_type` | string | No | Entities counted in `document_count` and `template_count`. Possible values: `document-all` (default): only documents or only templates, depending on the folder type. `all`: all entity types in the folder. `document`: documents that are not in a document group; `Documents`, `Archive`, and `Trash Bin` folders only. `document-group`: documents in document groups; `Documents`, `Archive`, and `Trash Bin` folders only. `template`: templates; `Templates` and `Trash Bin` folders only. `dgt`: document group templates; `Templates` and `Trash Bin` folders only. | ## Responses ### 200 * Success * With document group invite where user is the owner * With document group invite where user is the signer * With viewer field invites **Example** (`Success`) ```json { "id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Root Folder", "shared": false, "created": "1532531633", "folders": [ { "id": "25XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Templates", "shared": false, "created": "1532531633", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sub_folders": [], "folder_count": "0", "document_count": "0", "template_count": "11" }, { "id": "3bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Team Templates", "shared": true, "created": "1557915422", "team_id": "c3XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "team_name": "Sample team", "team_type": "VIEWABLE", "sub_folders": [], "folder_count": "0", "document_count": "0", "template_count": "3" }, { "id": "54XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Team Templates", "shared": true, "created": "1543922139", "team_id": "96XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "team_name": "My team", "team_type": "VIEWABLE", "sub_folders": [], "folder_count": "0", "document_count": "0", "template_count": "1" }, { "id": "83XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Archive", "shared": false, "created": "1532531633", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sub_folders": [], "folder_count": "0", "document_count": "21", "template_count": 0 }, { "id": "9eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Trash Bin", "shared": false, "created": "1567466970", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sub_folders": [], "folder_count": "0", "document_count": "0", "template_count": 0 }, { "id": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1532531633", "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "sub_folders": [], "folder_count": "0", "document_count": "74", "template_count": 0 } ], "user_id": "89XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [], "parent_id": null, "system_folder": false, "total_documents": 0 } ``` **Example** (`With viewer field invites`) ```json { "id": "a9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1616586778", "folders": [], "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": "document-owner@email.com", "created": 1616586981, "invites": [ { "email": "signer@email.com", "order": "1", "action": "sign", "status": "fulfilled", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_name": "Performance review", "authentication": null, "expiration_time": null }, { "email": "manager@email.com", "order": "2", "action": "sign", "status": "fulfilled", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_name": "Performance review", "authentication": null, "expiration_time": null }, { "order": "2", "action": "view", "status": "pending", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "e7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "HR team" }, "document_name": "Performance review", "authentication": null, "expiration_time": 1618210633 } ], "updated": 1616586981, "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "sample", "roles": [ "Signer 1", "Manager" ] } ], "invite_id": "eeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_group_name": "Document Group 24-3-2021", "viewer_field_invites": [ { "id": "eeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "e7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "HR team" } } ] } ], "parent_id": "66XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` **Example** (`With document group where user is a signer`) ```json { "id": "a9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1616586778", "folders": [], "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": "owner-email@email.com", "created": 1616586981, "updated": 1616586981, "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "sample", "roles": [ "Signer 1", "Signer 2" ], "field_invites": [ { "id": "e4XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "f6XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Contact group" } }, { "id": "u8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "c2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Contact group" } } ] } ], "invite_id": "eeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_group_name": "Document Group 24-3-2021" } ], "parent_id": "66XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` **Example** (`With document group invite where user is the owner`) ```json { "id": "a9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1616586778", "folders": [], "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "cdXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": "document-owner@email.com", "created": 1616586981, "invites": [ { "email": "signer@email.com", "order": "1", "action": "sign", "status": "fulfilled", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_name": "Performance review", "authentication": null, "expiration_time": null }, { "email": "manager@email.com", "order": "2", "action": "sign", "status": "fulfilled", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_name": "Performance review", "authentication": null, "expiration_time": null }, { "order": "2", "action": "view", "status": "pending", "document_id": "06XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email_group": { "id": "e7XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "HR team" }, "document_name": "Performance review", "authentication": null, "expiration_time": 1618210633 } ], "updated": 1616586981, "user_id": "30XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "sample", "roles": [ "Signer 1", "Manager" ] } ], "invite_id": "eeXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "document_group_name": "Document Group 24-3-2021" } ], "parent_id": "66XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` ### 400 * Get info about specific folder which doesn't belong to the user **Example** (`Get info about specific folder which doesn't belong to the user`) ```json { "errors": [ { "code": 65611, "message": "resource does not exist" } ] } ``` ## Code Examples > Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running. ### cURL ```bash curl -X GET \ "https://api.signnow.com/user/folder" \ -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" ``` --- *Full reference: https://docs.signnow.com/docs/folder/operations/get-all-folders*