Comms API ReferenceSender Pools

List SenderPools

This operation fetches a paginated list of SenderPools.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

OR
AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Query parameters

startDatestringOptionalformat: "date-time"
Filter to SenderPools created after the specified date and time in ISO 8601 format.
endDatestringOptionalformat: "date-time"
Filter to SenderPools created before the specified date and time in ISO 8601 format.
operationIdstringOptionalformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"
Filter to SenderPools by SenderPool Operation ID.
pageTokenstringOptional
A page token that represents the start SenderPool of a page
pageSizeintegerOptional1-1000Defaults to 50
Total number of items returned in a single page, the minimum is 1 and maximum is 1000. Default is 50.

Response

OK
senderPoolslist of objects
A list of SenderPools.
paginationobject
Metadata for paginated results. This object contains two tokens to navigate through paginated results. - Use `next` to retrieve the 'next' page in the result list. - Use `self` to retrieve the same page of the result list again. - Supply the token in the `pageToken` query param.

Errors

400
Bad Request Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error