API Reference

Get Templates

Retrieve specific template information. Permission: Read Templates

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=5

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string
Defaults to sort=+createdAt

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string
Defaults to createdAt=eq:2022-01-01

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

integer

Days to wait after the triggering event. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn

integer

Hours to wait after the triggering event. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn

integer

Minutes to wait after the triggering event. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn

integer

The hour of day (0-23) to send the communication. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn

string

The template content body. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

When the template was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

Days before a scheduled payment to send the communication. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

integer

Days prior to an event to send the communication. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The delivery channel. Possible values: Email, Text. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The event that triggers this communication. Possible values: AfterHoursTextTriggerEvent, AmortizationSchedulePaymentEvent, AutoResponseTriggerEvent, AutomationNotCompletedEvent, ContractAvailableEvent, CustomerAppliedEvent, CustomerCreatedEvent, CustomerWasTaggedEvent, LastPaymentMethodDisabledEvent, LoanApprovedEvent, LoanCreatedEvent, LoanDeniedEvent, LoanPaidOffEvent, LoanPendingEvent, LoanWasTaggedEvent, LoanWithdrawnExpiredEvent, NotifyCoBorrower, NotifySpouseWhenLoanIsApprovedEvent, PaymentLateEvent, PaymentPostedEvent, PaymentReversedEvent, PaymentScheduledByCustomerEvent, PaymentSettledEvent, RefinanceEligibility, RefinanceLoanTriggerEvent, RefinancedLoanPaidOffEvent, ScheduledPaymentEvent. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

boolean

Whether to include written-off loans. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

boolean

Whether the template is active. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

boolean

Whether to send immediately on the triggering event. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

Loan group UUIDs this template applies to. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The template name. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

Payment frequency filter. Possible values: weekly, bi-weekly, monthly, semi-monthly. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The scheduling strategy. Possible values: immediately, afterDaysAndHours, afterDaysAtHour, daysPrior, daysBeforeSchedulePayment. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

boolean

Whether to attach the loan contract PDF. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

The email subject line. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

The template type. Possible values: communication, contract, note. Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

string

When the template was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The template's unique identifier (UUID v4 format). Sortable: Yes. Filter Operators: eq, sw, in, nin, ne, neq, nn, null

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json