Skip to main content
GET
List sender names

Authorizations

Authorization
string
header
required

Beem API credentials: API key as username, API secret as password.

Query Parameters

page
integer

Page number to retrieve (starts at 1).

Required range: x >= 1
limit
integer

Maximum number of items to return per page.

Required range: x >= 1
sortBy
string

Field name to sort results by.

sortOrder
enum<string>

Sort direction: ascending or descending.

Available options:
asc,
desc,
ASC,
DESC
q
string

Search term to filter sender names.

status
string

Filter by sender name status (e.g. active, pending).

Response

Successful response

data
object[]

List of sender names on your account.

pagination
object