SIsignnow

Get all folders

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}.
get/user/folder

Request

Query parameters

Filter to apply to the document list. Possible values: signing-status, documents-created, documents-updated. Set the filter value in filter-values.

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.

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.

Sort order. Can be used only with sortby. Possible values: desc, asc. Default: desc.

Maximum number of documents to return. Max: 100. Larger values are reduced to 100.

Number of documents to skip before the returned page starts.

Whether to include subfolders in the response. Possible values: 1, 0. Must be used with include_documents_subfolders.

Whether to include subfolders in the response. Possible values: 1, 0. Must be used with subfolder-data.

Whether to include Team Documents folders. Possible values: true, false.

Whether to return only favorite documents and document groups. Possible values: true, false. Default: false.

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.

Response

  • Success
  • With document group invite where user is the owner
  • With document group invite where user is the signer
  • With viewer field invites
idstring

ID of the root folder.

namestring

Name of the root folder. Always Root.

sharedboolean

Whether the folder is shared.

createdstring

Unix timestamp of when the root folder was created, as a string.

user_idstring

ID of the user.

documentsobject[]

Documents directly in the root folder. Usually empty.

parent_idstring

ID of the parent folder. Always null for the root folder.

system_folderboolean

Whether the folder is a system folder. Always true for the root folder.

total_documentsinteger

Number of documents directly in the root folder.

Changes

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