Skip to navigation
API referenceTasksFolderSearchTasks

Search for folders

View as Markdown

Search for folders

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

Authentication

AuthorizationBearer

Docusign OAuth 2.0 access token, sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequiredformat: "uuid"
The ID of the Docusign account.

Query parameters

expandlist of stringsOptional

(AttributeGroups): Attribute groups saved on the folders.

Request

SearchTask object representing a search query specifically for folders.
StatusstringOptional
The progress of the task
AllWordsstringOptional
The search will match all words in this comma separated list
AnyWordsstringOptional
The search will match any words in this comma separated list
WithoutWordsstringOptional
The search will match only objects excluding the words in this comma separated list
PhrasestringOptional

A multi-word phrase on which to match

IncludeSubFoldersbooleanOptional
Whether to include subfolders of the InFolder in the search query
IsInTrashbooleanOptional
Whether to include trashed items in the search query
TitlestringOptional
Search for an object by its title
DescriptionstringOptional
Search for an object by its description
HrefstringOptional
Uri where the object can be retrieved.
InFolderobjectOptional
A specific folder in which to conduct the search
UpdatedByobjectOptional
Search for who last updated an object
ResultobjectOptional
The resulting collection of objects which match the search query

Response

OK
StatusstringOptional
The progress of the task
AllWordsstringOptional
The search will match all words in this comma separated list
AnyWordsstringOptional
The search will match any words in this comma separated list
WithoutWordsstringOptional
The search will match only objects excluding the words in this comma separated list
PhrasestringOptional

A multi-word phrase on which to match

IncludeSubFoldersbooleanOptional
Whether to include subfolders of the InFolder in the search query
IsInTrashbooleanOptional
Whether to include trashed items in the search query
TitlestringOptional
Search for an object by its title
DescriptionstringOptional
Search for an object by its description
HrefstringOptional
Uri where the object can be retrieved.
InFolderobjectOptional
A specific folder in which to conduct the search
UpdatedByobjectOptional
Search for who last updated an object
ResultobjectOptional
The resulting collection of objects which match the search query