Form Templates

List form templates

List form templates with sorting, filtering and cursor-based pagination support. Only templates available in the brand's library are returned, each with its full content and brand assets applied.

Scopes: forms.read

Rate Limiting: This endpoint is rate limited to 400 requests per minute.

Pagination: This endpoint uses cursor-based pagination. Use the after cursor from the response to get the next page, or the before cursor to get the previous page. Do not use both after and before parameters simultaneously.

Sorting:

  • Only single-field sorting is supported. You cannot sort by multiple fields.
  • Available sort fields: createdAt (default).
  • Sort parameters are only required on the first request. Subsequent requests using a cursor will automatically use the sort settings embedded in the cursor.

Cursor Behavior:

  • Cursors are self-contained and include all parameters needed for pagination.
  • Once you have a cursor, you only need to pass the cursor for subsequent pages.
  • If sort parameters are provided with a cursor, they must match the cursor's sort settings.
  • Cursors may become invalid if the underlying data changes significantly (e.g., the referenced template is removed).
get/form-templates

Request

  • Base URL
    https://api.omnisend.com/api
  • URL
    https://api.omnisend.com/api/form-templates
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://app.omnisend.com/oauth2/token scopes: forms.read
    • or API key in header Authorization

Query parameters

limitinteger

Page size (1-250)

afterstring

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

beforestring

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

sort'createdAt'

Sort field (only needed on first request)

direction'asc' | 'desc'

Sort direction (only needed on first request)

displayType'popup' | 'landingPage' | 'embedded' | 'flyout' | 'fullscreen'

Filter by display type

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Form templates list

Changes

No recorded changes to this operation across all 1 revision of this API.