get
https://gw.commpeak.com/textpeak/streams
Description
Summary: Retrieves a paginated list of streams with optional filtering. Details: This endpoint returns all streams available to the authenticated user, with support for filtering by type, state, ID, name, and IP ACL. Results are paginated and returned as a JSON array of stream objects along with pagination metadata.
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
All parameters are passed as query parameters and are optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | The page number for pagination. Default: 1. |
itemsPerPage | number | No | The number of items to include per page. Default: 30. |
type[] | string | No | Filter streams by one or more types. Can be repeated for multiple types. |
state[] | string | No | Filter streams by one or more states. Can be repeated for multiple states. |
id | string | No | Filter streams by a specific stream ID. |
name | string | No | Filter streams by name (partial or full match). |
ipAcl | string | No | Filter streams by IP ACL configuration. |
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…