Get all senders

get

https://api.commpeak.com/textpeak/senders

List all sender identities in your account.

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

≥ 1

Page number (1-based).

itemsPerPage

0 to 1000

Items per page, at most 1000.

order[id]

SortOrder | null

Sort by ID.

value

Sender value contains this text.

senderType

enum

Sender type (case-insensitive).

senderType[]

array | null

Any of these sender types.

status

enum

Approval status (case-insensitive).

status[]

array | null

Any of these approval statuses.

stream

Only senders bound to this stream ID.

createdAt[before]

Created on or before this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

createdAt[after]

Created on or after this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

Responses

200Successful Response