Skip to main content
GET
/
mail_templates
Get All With Filters
curl --request GET \
  --url https://api.sandbox.monite.com/v1/mail_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "body_template": "<string>",
      "is_default": true,
      "language": "<string>",
      "name": "<string>",
      "subject_template": "<string>",
      "type": "<string>"
    }
  ],
  "next_pagination_token": "<string>",
  "prev_pagination_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-monite-version
string<date>
required

Query Parameters

​
order
enum<string>
default:asc

Sort order (ascending by default). Typically used together with the sort parameter.

Available options:
asc,
desc
​
limit
integer
default:100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

Required range: 1 <= x <= 100
​
pagination_token
string

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

​
sort
enum<string>

The field to sort the results by. Typically used together with the order parameter.

Available options:
type,
name
​
type
enum<string>
Available options:
receivables_quote,
receivables_invoice,
receivables_paid_invoice,
receivables_credit_note,
receivables_discount_reminder,
receivables_final_reminder,
payables_purchase_order,
payables_notify_approver,
payables_notify_payer
​
type__in
enum<string>[]
Available options:
receivables_quote,
receivables_invoice,
receivables_paid_invoice,
receivables_credit_note,
receivables_discount_reminder,
receivables_final_reminder,
payables_purchase_order,
payables_notify_approver,
payables_notify_payer
​
type__not_in
enum<string>[]
Available options:
receivables_quote,
receivables_invoice,
receivables_paid_invoice,
receivables_credit_note,
receivables_discount_reminder,
receivables_final_reminder,
payables_purchase_order,
payables_notify_approver,
payables_notify_payer
​
is_default
boolean
​
name
string
​
name__iexact
string
​
name__contains
string
​
name__icontains
string

Response

Successful Response

​
data
object[]
required

All user-defined email templates

​
next_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

​
prev_pagination_token
string

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).