box-node-sdk

SignTemplatesManager

• List Box Sign templates
• Get Box Sign template by ID

List Box Sign templates

Gets Box Sign templates created by a user.

This operation is performed by calling function getSignTemplates.

See the endpoint docs at API Reference.

await client.signTemplates.getSignTemplates({
  limit: 2,
} satisfies GetSignTemplatesQueryParams);

Arguments

• queryParams GetSignTemplatesQueryParams
  • Query parameters of getSignTemplates method
• headersInput GetSignTemplatesHeadersInput
  • Headers of getSignTemplates method
• cancellationToken undefined | CancellationToken
  • Token used for request cancellation.

Returns

This function returns a value of type SignTemplates.

Returns a collection of templates.

Get Box Sign template by ID

Fetches details of a specific Box Sign template.

This operation is performed by calling function getSignTemplateById.

See the endpoint docs at API Reference.

await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!);

Arguments

• templateId string
  • The ID of a Box Sign template. Example: “123075213-7d117509-8f05-42e4-a5ef-5190a319d41d”
• optionalsInput GetSignTemplateByIdOptionalsInput

Returns

This function returns a value of type SignTemplate.

Returns details of a template.

This site is open source. Improve this page.