Skip to main content
POST
/
custom-templates
/
osm
/
search
Search OSM Templates
curl --request POST \
  --url https://api-0{dc}.moengage.com/v1.0/custom-templates/osm/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "entries": 10,
  "template_source": [
    "API"
  ],
  "sort_params": [
    {
      "last_modified_date": "DESCENDING"
    }
  ]
}
'
{
  "data": [
    {
      "meta_info": {
        "template_id": "1234567890123",
        "template_name": "NAME_OF_THE_TEMPLATE",
        "template_version": "1",
        "created_by": "test@moengage.com",
        "channel": "ON-SITE",
        "template_source": "API",
        "template_type": "CUSTOM"
      },
      "external_template_id": "4a1afbc5-4c31-4f19-8c23-793e27af01aa",
      "version": 1,
      "basic_details": {
        "payload": "<html>...</html>",
        "preview_image": "https://pbs.twimg.com/profile_images/10ydbKG1.jpg"
      },
      "created_by": "test@moengage.com",
      "created_at": "2023-08-01T07:58:53.880000",
      "updated_by": "test@moengage.com",
      "updated_at": "2023-08-01T07:58:53.880000"
    }
  ]
}
Mandatory Pagination We are introducing mandatory pagination, effective November 15, 2025. All calls to this API must include the following two parameters:
  • page: The page number of the results you wish to fetch.
  • entries: The number of templates to return per page, with a maximum value of 15.
Please update all integrations to include these parameters. API requests submitted without them after the effective date will result in an error and fail to execute.

​
Rate Limit

The rate limit is 100 RPM.

Authorizations

​
Authorization
string
header
required

The API request is authenticated through Basic Authentication. This sends a Base64-encoded string containing your username and password with every API request.

It encodes a username:password string in Base64 and appends the encoded string with Basic . This string is included in the authorization header: {"Authorization: "Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

Follow these steps to obtain the username and password from the MoEngage Dashboard:

  1. Navigate to Settings > Account > APIs.
  2. Copy the following details:
    • Username: Under Workspace ID (earlier App ID), click the copy icon.
    • Password: In the API keys section, click the copy icon in the Campaign report/Business events/Custom templates/Catalog API tile.

Body

application/json

Search filters for finding OSM templates. An empty body will fetch all templates. Pagination is mandatory after November 15, 2025.

All fields are optional. An empty request body will fetch all templates.

​
page
integer

The index of the page to be returned. Mandatory after Nov 15, 2025.

​
entries
integer

The number of entries/templates to return per page. Max 15. Mandatory after Nov 15, 2025.

Required range: x <= 15
​
template_name
string

The name of the template to search for. Returns templates matching this name.

​
template_id
string

The unique ID of the template provided by you.

​
template_source
enum<string>[]

Filter templates by their source.

Available options:
API,
MOENGAGE
​
template_type
enum<string>[]

Filter templates by type (Custom or Pre-built).

Available options:
CUSTOM,
PRE_BUILT
​
created_by
string<email>[]

Filter templates by the creator's email identifier.

​
updated_by
string<email>[]

Filter templates by the updater's email identifier.

​
sort_params
object[]

Sort the templates by multiple fields in ASCENDING or DESCENDING order. Priority follows the array order.

​
external_template_ids
object[]

Search for multiple templates using pairs of external_template_id and version.

Response

Search successful. Returns a list of templates.

​
data
object[]

A list containing the details of the templates found.