Description
Summary: Retrieves a paginated list of all stream event templates via the TextPeak API.
Details: This endpoint returns all available stream event templates configured in your account. Stream event templates define the structure and behavior of events used across messaging streams (e.g., WhatsApp template names, notification triggers, OTP events). The response is paginated — use the page and itemsPerPage query parameters to control which page of results is returned and how many items appear per page. Authentication is performed via a TextPeak API key passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a TextPeak API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the API key.
| Method | Details |
|---|---|
| API Key | Pass your TextPeak API key directly in the Authorization header value. |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your TextPeak API key that authenticates the request. |
accept | Yes | Must be set to application/json. Indicates that the client expects a JSON response. |
Parameters
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | 1 | The page number to retrieve in the paginated result set. |
itemsPerPage | integer | No | 30 | The number of stream event templates to return per page. |
Request Body
This endpoint does not require a request body.
Examples
This endpoint has a saved example demonstrating usage:
- Get all stream event templates — Retrieving a paginated list of all available stream event templates.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||