Description
Summary: Retrieves a single stream event template by its ID via the TextPeak API.
Details: This endpoint returns the full details of a specific stream event template identified by its unique ID. Use this to inspect the configuration, structure, and metadata of an individual event template — for example, to review the template name, associated channels, variable placeholders, or delivery settings. This is useful when you need to look up a specific template before sending it or when verifying template details during integration development. 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
Path Variables
| Variable | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the stream event template to retrieve. |
Request Body
This endpoint does not require a request body.
Examples
This endpoint has a saved example demonstrating usage:
- Get stream event template — Retrieving the full details of a specific stream event template by its ID.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||