list_templates
Retrieve and filter BoldSign e-signature templates by type, creator, labels, date range, or brand to quickly find reusable document templates for signing workflows.
Instructions
Retrieves a paginated list of BoldSign templates with options to filter by page number, page size, search key, template type, creator, labels, creation date range, and brand IDs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brandIds | No | Optional. Filters templates associated with the specified brand IDs. | |
| createdBy | No | Optional. Filters templates based on the email address(es) of their creators. | |
| endDate | No | Optional. Filters templates created on or before this date (in YYYY-MM-DD format). | |
| page | Yes | ||
| pageSize | Yes | ||
| searchKey | No | Optional. A search key to filter templates by properties such as name and email address. Provides a way to refine results based on specific criteria. | |
| startDate | No | Optional. Filters templates created on or after this date (in YYYY-MM-DD format). | |
| templateLabels | No | Optional. Filters templates based on associated labels (tags). | |
| templateType | Yes | Optional. Filters templates based on their type (all, mytemplates, sharedtemplate). Defaults to 'all'. | all |
Input Schema (JSON Schema)
{
"properties": {
"brandIds": {
"anyOf": [
{
"items": {
"description": "The unique identifier (ID) of the brand to be used for depicting a brand.",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates associated with the specified brand IDs."
},
"createdBy": {
"anyOf": [
{
"items": {
"description": "Email address of the template creator.",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates based on the email address(es) of their creators."
},
"endDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates created on or before this date (in YYYY-MM-DD format)."
},
"page": {
"default": 1,
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"pageSize": {
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"searchKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. A search key to filter templates by properties such as name and email address. Provides a way to refine results based on specific criteria."
},
"startDate": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates created on or after this date (in YYYY-MM-DD format)."
},
"templateLabels": {
"anyOf": [
{
"items": {
"description": "Label of the template.",
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates based on associated labels (tags)."
},
"templateType": {
"anyOf": [
{
"enum": [
"all",
"mytemplates",
"sharedtemplate"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "all",
"description": "Optional. Filters templates based on their type (all, mytemplates, sharedtemplate). Defaults to 'all'."
}
},
"required": [
"pageSize",
"page",
"templateType"
],
"type": "object"
}