get
https://gw.commpeak.com/textpeak/senders
Description
Summary: Retrieves a paginated list of all senders associated with your account. Details: This endpoint returns a collection of sender resources. Results are paginated and can be filtered by various criteria including sender type, status, and value. Use the query parameters to control pagination and narrow down results.
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 |
|---|---|---|---|---|
page | integer | Query | No | The page number to retrieve. Default: 1. |
itemsPerPage | integer | Query | No | The number of items to return per page. Default: 30. |
senderType[] | string | Query | No | Filter by one or more sender types (pass multiple values). |
status[] | string | Query | No | Filter by one or more sender statuses (pass multiple values). |
value | string | Query | No | Filter senders by value (e.g., phone number or alphanumeric name). |
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…