API Reference

Search overlay templates

get
https://api5.optimove.net/content/v1/templates/overlay

Returns a page of the tenant's overlay templates, without their content. Use GET /templates/overlay/{id} to get a template's content.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params

Text to search for in the template name and HTML. Ignored when shorter than 3 characters.

uuid

Returns only items in this folder.

date-time

Returns only items last updated at or after this time (inclusive).
ISO 8601 in UTC, with or without Z, for example 2026-10-01T00:00:00Z. A date without a time means midnight UTC.
Can't be later than dateTo.

date-time

Returns only items last updated at or before this time (inclusive).
ISO 8601 in UTC, with or without Z, for example 2026-10-31T23:59:59Z.
A date without a time means midnight UTC at the start of that day, so dateTo=2026-10-31 excludes almost all of October 31.
To include the whole day, pass 2026-10-31T23:59:59Z.

int32
≥ 0
Defaults to 0

Number of items to skip.

int32
1 to 100
Defaults to 20

Maximum number of items to return.

string
enum
Defaults to date-newest

Sort order of the results:

  • date-newest: last updated first
  • date-oldest: last updated last
  • name-asc: by name, A to Z
  • name-desc: by name, Z to A
Allowed:
Responses

401

The X-API-KEY header is missing or the API key is not valid.

403

The API key doesn't have the admin role, or the tenant isn't allowed to change this item.

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated about 1 hour ago

Did this page help you?