API Reference
Log InRequest Live Demo
  1. CommPeak TextPeak API
  2. Streams

Get all streams

get
https://api.commpeak.com/textpeak/streams

List all streams in your account. Your account's default stream is not listed.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
≥ 1

Page number (1-based).

0 to 1000

Items per page, at most 1000.

SortOrder | null

Sort by ID.

Exact stream ID.

Stream name contains this text.

enum

Stream type (case-insensitive).

array | null

Any of these stream types.

enum

Stream state (case-insensitive).

array | null

Any of these stream states.

IP allow-list contains this text.

Only streams with this tag ID.

Responses

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?