Skip to main content

TemplateSearchInput

Search criteria for filtering message templates.

Provides comprehensive filtering options for template searches including type classification, default template designations, and pagination. Supports sorting and can filter by specific template identifiers for targeted retrieval.

input TemplateSearchInput {
  types: [TemplateType!]
  ids: [String!]
  isDefaultOrderPdf: Boolean
  isDefaultQuotePdf: Boolean
  offset: Int
  page: Int
  sortInputs: [TemplateSortInput!]
}

Fields​

TemplateSearchInput.types ● [TemplateType!] list enum​

Filter by template type classification.

Limits results to specific template types (EMAIL or DOCUMENT) for focused template management and type-specific operations.

TemplateSearchInput.ids ● [String!] list scalar​

Filter by specific template identifiers.

Limits results to templates with the specified UUIDs, enabling targeted retrieval of known templates for management or processing operations.

Validation: Must be valid UUIDs.

TemplateSearchInput.isDefaultOrderPdf ● Boolean scalar​

Filter by default order PDF designation.

When true, returns only templates designated as default for order PDF generation. When false, excludes default order PDF templates.

TemplateSearchInput.isDefaultQuotePdf ● Boolean scalar​

Filter by default quote PDF designation.

When true, returns only templates designated as default for quote PDF generation. When false, excludes default quote PDF templates.

TemplateSearchInput.offset ● Int scalar​

Number of template items to return per page.

Controls pagination size for manageable result sets and optimal performance during template browsing and search operations.

TemplateSearchInput.page ● Int scalar​

Page number for paginated template results.

Specifies which page of results to retrieve when dealing with large template datasets, enabling navigation through extensive template collections.

TemplateSearchInput.sortInputs ● [TemplateSortInput!] list input​

Sorting criteria for template result organization.

Defines how templates should be ordered in the results, supporting multiple sort criteria with different directions for comprehensive result organization.

Validation: When provided, array must not be empty and must contain unique sort configurations.

Member Of​

templates query