Skip to content
docs
ES
CatalogNotifications

List templates

Returns templates paginated by page and pageSize; requires groups, filters by channel and locale.

GET/v1/notifications/templates
Requires an access token with the notification:read permission.

Query Parameters

page?integer

One-based page number.

Formatint32
pageSize?integer
Formatint32
search?string

Free-text search.

sortBy?string

Field to sort by.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
channel?string

Notification channel, such as email or whatsApp.

Value in

  • "email"
  • "sms"
  • "push"
  • "whatsApp"
  • "inApp"
  • "webhook"
groups*array<string>
statuses?array<>

Only items in these statuses.

Value in

  • "draft"
  • "active"
  • "archived"
key?string
locale?string

Language code for localized content.

scope?string

store for your store's own templates, system for the default ones.

Value in

  • "system"
  • "store"

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.ecomiq.pe/api/v1/notifications/templates?groups=Confirmaci%C3%B3n+de+pedido" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "pageIndex": 1,  "pageSize": 25,  "count": 24,  "data": [    {      "id": "7204558912004326810",      "group": "Confirmación de pedido",      "name": "Confirmación de pedido",      "key": "color",      "notification": "email",      "version": 3,      "status": "draft",      "storeId": "7204558912004327977"    }  ],  "totalPages": 1,  "hasPreviousPage": false,  "hasNextPage": true}