v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View templates

Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps.

get/templates?app_id={app_id}&limit={limit}&offset={offset}

Query parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

limitinteger

The maximum number of templates returned per request. The default (if omitted) and maximum is 50 templates per request.

offsetinteger

The pagination or "starting point" of the templates to be returned. Setting it to 0 with a limit of 50 will retrieve the first 50 templates. Increasing the offset by 50 will return the next set of templates, and so on.

channel'push' | 'email' | 'sms'

Filter the fetched templates by the delivery channel. Available options are: push, email, and SMS.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Content-Typestring required

Response

200

limitinteger
offsetinteger
total_countinteger

Example response

{
  "limit": 50,
  "total_count": 3
}