fastify-x-signwell
xsignwell.templates.list
List all SignWell templates with optional page-based pagination.
xsignwell.templates.list
List all SignWell templates with optional page-based pagination.
Signature
fastify.xsignwell.templates.list(
params?: { page?: number; limit?: number }
): Promise<Object>
Params
| Name | Type | Required | Description |
|---|---|---|---|
params.page | number | No | Page number. |
params.limit | number | No | Results per page. |
Returns
A paginated list of template summaries from the SignWell API.
Throws
- Re-throws SignWell API errors with
statusCodeandsignwellErrorproperties.
Examples
List templates with pagination
const result = await fastify.xsignwell.templates.list({ limit: 20 });
for (const tmpl of result.templates) {
console.log(tmpl.id, tmpl.name);
}
List first page with default page size
const result = await fastify.xsignwell.templates.list();
See also
- templates.get — fetch a single template by ID
- templates.create — create a new template
- documents.createFromTemplate — instantiate a document from a template
AI Context
package: "@xenterprises/fastify-xsignwell"
method: fastify.xsignwell.templates.list(params?)
use-when: List all SignWell templates with optional page-based pagination to browse available templates
params: page (optional), limit (optional)
returns: Paginated list of template summaries