v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB

Email Templates

Get email templates

With this endpoint you can get a paginated list of email templates.

Sorting: Use sort and direction to control the order of results. Supported sort fields: createdAt (default), name. Supported directions: asc, desc (default).

Filtering: Use nameContains to filter templates by name (case-insensitive partial match, max 200 characters)

Pagination: This endpoint uses cursor-based pagination for efficient traversal of large datasets.

Use the paging.cursors.after value from the response to get the next page
Use the paging.cursors.before value from the response to get the previous page
The paging.hasMore field indicates if more results are available
Do not use both after and before parameters simultaneously
Maximum page size is 100 items (default 50)
If limit is less than 1 or greater than 100, returns 400 Bad Request

Scopes: email-templates.read

get/email-templates

Query parameters

limitinteger

Number of items per page (1-100, default 50)

afterstring

Cursor for next page (base64-encoded, from previous response)

beforestring

Cursor for previous page (base64-encoded, from previous response)

sort'createdAt' | 'name'

Sort field (createdAt, name; default createdAt)

direction'asc' | 'desc'

Sort direction (asc, desc; default desc)

nameContainsstring

Filter templates by name (case-insensitive partial match, max 200 characters)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

List of email templates with pagination

Example response

{
  "paging": {
    "cursors": {
      "after": "eyJpZCI6ImNhbXAtNDU2In0",
      "before": "eyJpZCI6ImNhbXAtMTIzIn0"
    },
    "hasMore": true,
    "limit": 50
  },
  "templates": [
    {
      "createdAt": "2021-01-01T01:02:03Z",
      "id": "68beca12d2e99b0c8d19fd5e",
      "name": "Welcome Email 1",
      "updatedAt": "2021-01-01T01:02:03Z"
    }
  ]
}