Skip to content
docs
Guides
ES
CatalogNotifications
notification:read

List templates

GET/v1/notifications/templates

List templates. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

page?integer

One-based page number.

Formatint32
pageSize?integer
Formatint32
search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
channel?string

Sales channel code.

Value in

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

Only items in these statuses.

key?string
locale?string

Language code for localized content.

scope?string

Scope of the operation.

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://example.com/v1/notifications/templates?groups=example" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "pageIndex": 1,  "pageSize": 1,  "count": 1,  "data": [    {      "id": "7204558912004325301",      "group": "example",      "name": "Example resource",      "key": "example",      "notification": "email",      "version": 1,      "status": "draft",      "storeId": "7204558912004325301"    }  ],  "totalPages": 1,  "hasPreviousPage": false,  "hasNextPage": false}