list_templates
Retrieve and filter BoldSign templates by page number, size, search key, type, creator, labels, creation date range, or brand IDs for precise template management.
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 | No | Required. The page number to retrieve the templates list. Used for pagination to navigate through the list of available templates. | |
| pageSize | No | Optional. Specifies the number of templates to retrieve per page. The value must be an integer between 1 and 100. If not provided, the BoldSign API defaults to a page size of 10. | |
| 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 | No | Optional. Filters templates based on their type (all, mytemplates, sharedtemplate). Defaults to 'all'. | all |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"brandIds": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"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": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"description": "Email address of the template creator.",
"format": "email",
"type": "string"
},
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. Filters templates based on the email address(es) of their creators."
},
"endDate": {
"anyOf": [
{
"$ref": "#/properties/startDate/anyOf/0"
},
{
"type": "null"
}
],
"description": "Optional. Filters templates created on or before this date (in YYYY-MM-DD format)."
},
"page": {
"default": 1,
"description": "Required. The page number to retrieve the templates list. Used for pagination to navigate through the list of available templates.",
"minimum": 1,
"type": "integer"
},
"pageSize": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"maximum": 100,
"minimum": 1,
"type": "integer"
}
]
},
{
"type": "null"
}
],
"default": 10,
"description": "Optional. Specifies the number of templates to retrieve per page. The value must be an integer between 1 and 100. If not provided, the BoldSign API defaults to a page size of 10."
},
"searchKey": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"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": [
{
"anyOf": [
{
"not": {}
},
{
"format": "date-time",
"type": "string"
}
]
},
{
"type": "null"
}
],
"description": "Optional. Filters templates created on or after this date (in YYYY-MM-DD format)."
},
"templateLabels": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"items": {
"description": "Label of the template.",
"type": "string"
},
"type": "array"
}
]
},
{
"type": "null"
}
],
"description": "Optional. Filters templates based on associated labels (tags)."
},
"templateType": {
"anyOf": [
{
"anyOf": [
{
"not": {}
},
{
"enum": [
"all",
"mytemplates",
"sharedtemplate"
],
"type": "string"
}
]
},
{
"type": "null"
}
],
"default": "all",
"description": "Optional. Filters templates based on their type (all, mytemplates, sharedtemplate). Defaults to 'all'."
}
},
"type": "object"
}