get
https://gw.commpeak.com/textpeak/streams/
Description
Summary: Retrieves the details of a single stream by its unique identifier. Details: This endpoint returns the full stream object for the specified stream ID, including its configuration, state, type, associated senders, and other metadata. Use this to inspect or verify the properties of a specific stream.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
accept | No | Expected response format. Default: application/json. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
id | number | Path | Yes | The unique identifier of the stream to retrieve. In the URL pattern /streams/{id}, replace {id} with the stream ID. |
Request Body
This endpoint does not use a request body.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…