SIsignnow

Get folder by id

This endpoint allows API users to retrieve the details of a folder, including its subfolders and the documents it contains. Use query parameters to filter, sort, and paginate the document list.

Notes

  • total_documents is the total number of documents in the folder. The documents array contains only the page selected by limit and offset.
  • To include document group templates, set entity_type to dgt or all. By default, a templates folder returns only templates.
  • Each document's document_group_template_info lists the active document group templates that include it. For a document that isn't part of any document group template, the array is empty.
get/folder/{folder_id}

Request

Path parameters

ID of the folder to return.

Query parameters

Value for the filter set in filters. For filters=signing-status, one of: signed, pending, waiting-for-me, waiting-for-others, unsent, expired. For filters=documents-created or filters=documents-updated, a Unix timestamp: the response includes documents created or updated after this time.

Field to sort documents by. Possible values: updated, created, document-name.

Order of sorting. Can be used only with sortby. Possible values: asc, desc.

Number of documents to skip before the returned page starts.

Maximum number of documents to return. Max: 100.

Entities to include in the response. Possible values: document-all (documents, including documents in document groups), document (documents that aren't in document groups), document-group (document groups only), template (templates only), dgt (document group templates only), all (documents and document groups, or templates and document group templates in a templates folder).

Label to filter documents and document groups by. Possible values: declined (the invite was declined), undelivered (the invite email wasn't delivered). To use both, separate them with a comma: declined,undelivered.

Filter to apply to the document list. Possible values: signing-status, documents-created, documents-updated. Use with filter-values. The documents-created and documents-updated filters exclude templates.

Whether to include subfolders to the response. Allowed values: 1, 0.

Whether to display Team Documents folders.

Whether to show only favorite documents and document groups.

Response

  • 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
idstring

ID of the folder.

namestring

Name of the folder.

sharedboolean

Whether the folder is shared.

createdstring

Folder creation time as a Unix timestamp.

team_idstring

ID of the team. Team folders only.

user_idstring

ID of the folder owner.

parent_idstring

ID of the parent folder.

team_namestring

Name of the team. Team folders only.

team_typestring

Type of the team. Team folders only.

system_folderboolean

Whether the folder is a system folder, such as Documents or Templates.

total_documentsinteger

Total number of documents in the folder, across all pages.

Changes

No recorded changes to this operation across all 1 revision of this API.