v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View messages

View the details for a collection of messages.

get/notifications?app_id={app_id}&limit={limit}&offset={offset}&kind={kind}&template_id={template_id}&time_offset={time_offset}

Query parameters

app_idstring required

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

limitinteger

Specifies the maximum number of messages to return in a single query. The maximum and default is 50 messages per request.

offsetinteger

Controls the starting point for the notifications being returned. Default is 0. Results are returned and sorted in descending order by queued_at.

kindinteger

Specifies which push notifications to return based on how it was created. Use this to segment push by their creation method, allowing for targeted analysis or management of notification types. All push types are returned by default. 0 - Notifications created through the dashboard. 1 - Notifications sent via API calls. 3 - Notifications triggered through automated systems.

template_idstring

The template ID in UUID v4 format set for the message if applicable. See Templates.

time_offsetstring

An ISO 8601 formatted timestamp or Base64 integer token (provided in the API response). See time_offset Accepted Values.

Headers

Authorizationstring required

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

Response

200

total_countinteger

The total number of messages available in the dashboard irrespective of page

time_offsetstring

The time_offset if specified in the request.

next_time_offsetstring

A Base64-encoded cursor token representing the next group of messages to fetch if time_offset provided.

offsetinteger

The offset specified. Defaults to 0 if not provided in the request.

limitinteger

The limit specified. Defaults to 50 if not provided in the request.