--- title: "Get folder by id" url: "https://docs.signnow.com/docs/folder/operations/get-folder-by-id" type: "endpoint" section: "folder" slug: "folder/operations/get-folder-by-id" method: "GET" path: "/folder/{folder_id}" operation_id: "get-folder-by-id" authorization: "bearer" --- # Get folder by id `GET /folder/{folder_id}` Returns all details of a specific folder including an array of all documents in that folder. Adjust the response using query parameters. ## Authorization bearer ## Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `folder_id` | string | Yes | | ## Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `filter-values` | string | No | If `filters=signing-status`, possible values are: `signed`, `pending`, `waiting-for-me`, `waiting-for-others`, `unsent`, `expired`.
If `filters=documents-created`, must be a UNIX timestamp and the documents that were created after this date are returned.
If `filters=documents-updated`, must be a UNIX timestamp and the documents that were updated after this date are returned. | | `sortby` | string | No | Sort by created date, updated date, or document name.
Possible values: `updated`, `created`, `document-name`. | | `order` | string | No | Order of sorting. Can be used only with `sortby`. Possible values: `asc`, `desc`. | | `offset` | integer | No | Display documents from this position (by skipping this number of documents starting from the first one). | | `limit` | integer | No | Maximum number of documents to return. | | `entity_type` | string | No | Defines what entities should be in the response.
Possible values:
- `document-all` (separate documents and documents from doc groups)
- `all` (documents and doc groups)
- `document` (documents that are not in doc groups)
- `document-group` (doc groups only) | | `entity_labels` | string | No | Filters the documents or document groups in the response.
Possible values: `declined` (the invite was declined), `undelivered` (the invite email wasn't delivered). Can be used at the same time. | | `filters` | string | No | Filter documents by status, created date, or updated date.
Possible values: `signing-status`, `documents-created`, `documents-updated`. Must be used with the `filter-values` parameter. Filters by created date and created date exclude templates. | | `include_documents_subfolders` | boolean | No | Whether to include subfolders to the response. Allowed values: `1`, `0`. | | `with_team_documents ` | boolean | No | Whether to display Team Documents folders. | | `only_favorites` | boolean | No | Whether to show only favorite documents and document groups. | ## Responses ### 200 * Success * With document group where user is a signer (+email group) * With document group where user is the owner (+email group) * With viewer field invites (+email group) * With `entity_type=document-group` query * With `entity_type=dgt` query **Example** (`Success`) ```json { "id": "18XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1409253077", "folders": [], "user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "tags": [ { "name": "fields", "type": "system" } ], "owner": "document_owner@email.com", "roles": [ { "name": "Client", "unique_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "signing_order": "1" } ], "seals": [], "texts": [ { "x": "281", "y": "195", "id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "data": "10/16/14", "font": "Arial", "size": "8", "email": "email_address@email.com", "created": "1413485018", "user_id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "line_height": "9.08", "page_number": "0" } ], "checks": [], "fields": [ { "id": "ecXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "type": "text", "role_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "40XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "fulfiller@email.com", "element_id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "originator": "originator@email.com", "json_attributes": { "x": 281, "y": 195, "label": "Date", "width": 102, "height": 21, "required": true, "page_number": 0, "prefilled_text": "" }, "field_request_id": "40XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": "72XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_request_canceled": null }, { "id": "43XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "type": "signature", "role_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "4dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "fulfiller@email.com", "element_id": "5cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "originator": "originator@email.com", "json_attributes": { "x": 91, "y": 186, "width": 122, "height": 34, "required": true, "page_number": 0 }, "field_request_id": "4dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": "e9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_request_canceled": null } ], "created": "1413307342", "inserts": [], "updated": "1413485018", "user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "requests": [ { "email_sent_statuses": [ { "status": "sent", "created_at": 1640108848, "last_reaction_at": 1640108848 }, { "status": "mail_open", "created_at": 1640108848, "last_reaction_at": 1640108849 }, { "status": "bounce", "created_at": 1640108848, "last_reaction_at": 1640108851 }, { "status": "mail_click", "created_at": 1640108848, "last_reaction_at": 1640108850 } ] } ], "template": false, "parent_id": "18XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "thumbnail": { "large": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large", "small": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small", "medium": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium" }, "page_count": "1", "signatures": [ { "x": "91", "y": "195", "id": "5cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "email": "email_address@email.com", "width": "122", "height": "25", "created": "1413485018", "user_id": "abXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "page_number": "0" } ], "attachments": [], "exported_to": [ { "is_exported": false, "export_domain": "example.com", "exported_user_ids": [] } ], "is_favorite": false, "version_time": "1413485018", "document_name": "Document 1", "entity_labels": [], "field_invites": [ { "id": "73XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "email": "user@email.com", "status": "fulfilled", "updated": "1413485018" }, { "email_sent_statuses": [ { "status": "sent", "created_at": 1640108848, "last_reaction_at": 1640108848 }, { "status": "mail_open", "created_at": 1640108848, "last_reaction_at": 1640108849 }, { "status": "bounce", "created_at": 1640108848, "last_reaction_at": 1640108851 }, { "status": "mail_click", "created_at": 1640108848, "last_reaction_at": 1640108850 } ] } ], "notary_invites": [], "origin_user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "original_filename": "document_sample.pdf", "origin_document_id": "4aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "enumeration_options": [] } ], "parent_id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` **Example** (`With declined document `) ```json { "id": "18XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Documents", "shared": false, "created": "1409253077", "folders": [], "user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "tags": [ { "name": "fields", "type": "system" } ], "owner": "document_owner@email.com", "roles": [ { "name": "Client", "unique_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "signing_order": "1" } ], "seals": [], "texts": [], "checks": [], "fields": [ { "id": "ecXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "type": "text", "role_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "40XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "fulfiller@email.com", "element_id": "d2XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "originator": "originator@email.com", "json_attributes": { "x": 281, "y": 195, "label": "Date", "width": 102, "height": 21, "required": true, "page_number": 0, "prefilled_text": "" }, "field_request_id": "40XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": "72XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_request_canceled": null }, { "id": "43XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "type": "signature", "role_id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_id": "4dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "fulfiller": "fulfiller@email.com", "element_id": "5cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "originator": "originator@email.com", "json_attributes": { "x": 91, "y": 186, "width": 122, "height": 34, "required": true, "page_number": 0 }, "field_request_id": "4dXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "template_field_id": "e9XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "field_request_canceled": null } ], "created": "1413307342", "inserts": [], "updated": "1413485018", "user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "requests": [], "template": false, "parent_id": "18XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "thumbnail": { "large": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=large", "small": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=small", "medium": "http://example.com/document/85XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/thumbnail?size=medium" }, "page_count": "1", "signatures": [], "attachments": [], "exported_to": [ { "is_exported": false, "export_domain": "example.com", "exported_user_ids": [] } ], "is_favorite": false, "version_time": "1413485018", "document_name": "Document 1", "entity_labels": [ { "updated": 1716320189, "is_system": true, "label_name": "declined" } ], "field_invites": [ { "id": "73XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "role": "Client", "email": "user@email.com", "status": "fulfilled", "updated": "1413485018" }, { "email_sent_statuses": [ { "status": "sent", "created_at": 1640108848, "last_reaction_at": 1640108848 }, { "status": "mail_open", "created_at": 1640108848, "last_reaction_at": 1640108849 }, { "status": "bounce", "created_at": 1640108848, "last_reaction_at": 1640108851 }, { "status": "mail_click", "created_at": 1640108848, "last_reaction_at": 1640108850 } ] } ], "notary_invites": [], "origin_user_id": "38XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "original_filename": "document_sample.pdf", "origin_document_id": "4aXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "enumeration_options": [] } ], "parent_id": "07XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` **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", "entity_labels": [], "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 `entity_type=dgt` query`) ```json { "id": "daXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": "document-group-owner@email.com", "state": null, "pinned": false, "created": 1693474793, "invites": [], "updated": 1693474793, "user_id": "09XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "10XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample image", "roles": [], "settings": null }, { "id": "13XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample image", "roles": [ "Recipient 1" ], "settings": null } ], "invite_id": null, "parent_id": "f1XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "entity_type": "dgt", "is_favorite": false, "entity_labels": [], "recently_used": 1693474793, "sign_as_merged": false, "freeform_actions": [], "freeform_invite_id": null, "document_group_name": "Sample Document group", "originator_organization_settings": [] } ``` **Example** (`With `entity_type=document-group` query`) ```json { "id": "49XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "owner": "document-group-owner@email.com", "state": "created", "pinned": false, "status": "created", "created": 1695288759, "invites": [], "updated": 1695288759, "user_id": "09XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "documents": [ { "id": "2cXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample image", "roles": [], "settings": { "advanced_signing_flow": false } }, { "id": "82XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "name": "Sample image", "roles": [ "Recipient 1" ], "settings": { "advanced_signing_flow": false } } ], "invite_id": null, "parent_id": "fbXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "entity_type": "document-group", "is_favorite": false, "entity_labels": [], "recently_used": 1695288759, "sign_as_merged": false, "freeform_actions": [], "freeform_invite_id": null, "document_group_name": "Sample Document group", "originator_organization_settings": [] } ``` **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", "entity_labels": [], "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", "entity_labels": [], "document_group_name": "Document Group 24-3-2021" } ], "parent_id": "66XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "system_folder": true, "total_documents": 1 } ``` ### 400 Get info of specific folder which doesn't belong to user **Example** (`Get info of specific folder which doesn't belong to user`) ```json { "code": 65611, "message": "Resource doesn't exist" } ``` ## Code Examples > Replace `$SIGNNOW_ACCESS_TOKEN` and any `{placeholder}` values before running. ### cURL ```bash curl -X GET \ "https://api.signnow.com/folder/{folder_id}" \ -H "Authorization: Bearer $SIGNNOW_ACCESS_TOKEN" ``` --- *Full reference: https://docs.signnow.com/docs/folder/operations/get-folder-by-id*