Search In-app Templates
curl --request POST \
--url https://api-{dc}.moengage.com/v1.0/custom-templates/inapp/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"page": 1,
"entries": 15,
"template_source": [
"API"
],
"sort_params": [
{
"template_name": "ASCENDING"
}
]
}
'{
"data": [
{
"external_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"basic_details": {
"payload": "<string>",
"preview_image": "<string>",
"inapp_template_type": "SELF_HANDLED"
},
"meta_info": {
"template_id": "<string>",
"template_name": "<string>",
"template_version": "<string>",
"created_by": "<string>",
"channel": "INAPP",
"template_source": "API",
"template_type": "CUSTOM"
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"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"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Search In-app Templates
This API searches the In-app templates created in your MoEngage account.
POST
/
custom-templates
/
inapp
/
search
Search In-app Templates
curl --request POST \
--url https://api-{dc}.moengage.com/v1.0/custom-templates/inapp/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"page": 1,
"entries": 15,
"template_source": [
"API"
],
"sort_params": [
{
"template_name": "ASCENDING"
}
]
}
'{
"data": [
{
"external_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"basic_details": {
"payload": "<string>",
"preview_image": "<string>",
"inapp_template_type": "SELF_HANDLED"
},
"meta_info": {
"template_id": "<string>",
"template_name": "<string>",
"template_version": "<string>",
"created_by": "<string>",
"channel": "INAPP",
"template_source": "API",
"template_type": "CUSTOM"
},
"created_by": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}{
"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"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"code": "<string>",
"target": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Mandatory PaginationWe 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.
承認
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 In-app templates.
Notes:
pageandentriesare mandatory effective November 15, 2025. All other fields are optional.- If the request body is passed empty, then all templates will be returned.
- Here, the preview_image field will be generated by MoEngage for the HTML template payload.
レスポンス
The template was searched successfully.