Search OSM Templates
curl --request POST \
--url https://api-{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": "[email protected]",
"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": "[email protected]",
"created_at": "2023-08-01T07:58:53.880000",
"updated_by": "[email protected]",
"updated_at": "2023-08-01T07:58:53.880000"
}
]
}{
"error": {
"code": "400 Bad Request",
"message": "Validation failed because of invalid request data",
"details": [
{
"code": "MissingValue",
"target": "external_template_ids",
"message": "external_template_id or version is missing in external_template_ids."
}
],
"request_id": "npmQrbNE"
}
}{
"response_id": "OUUkHvcn",
"type": "custom_template",
"error": {
"code": "Too Many Requests",
"message": "API rate limit breached. Current limit: n/m mins"
}
}{
"title": "Internal Server Error",
"message": "An unexpected error was encountered while processing this request. Please contact MoEngage Team"
}Search OSM Templates
This API searches the OSM templates created in your MoEngage account.
POST
/
custom-templates
/
osm
/
search
Search OSM Templates
curl --request POST \
--url https://api-{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": "[email protected]",
"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": "[email protected]",
"created_at": "2023-08-01T07:58:53.880000",
"updated_by": "[email protected]",
"updated_at": "2023-08-01T07:58:53.880000"
}
]
}{
"error": {
"code": "400 Bad Request",
"message": "Validation failed because of invalid request data",
"details": [
{
"code": "MissingValue",
"target": "external_template_ids",
"message": "external_template_id or version is missing in external_template_ids."
}
],
"request_id": "npmQrbNE"
}
}{
"response_id": "OUUkHvcn",
"type": "custom_template",
"error": {
"code": "Too Many Requests",
"message": "API rate limit breached. Current limit: n/m mins"
}
}{
"title": "Internal Server Error",
"message": "An unexpected error was encountered while processing this request. Please contact MoEngage Team"
}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.
Rate Limit
The rate limit is 100 RPM.承認
Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.
- Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
- Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.
For more information on authentication and getting your credentials, refer here.
ボディ
application/json
Search filters for finding OSM templates.
Notes:
pageandentriesare mandatory effective November 15, 2025. All other fields are optional.- An empty request body will fetch all templates.