Skip to main content
GET
List split recipients

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

page
integer
default:0

Zero-based page number. Negative values are treated as 0.

Required range: x >= 0
size
integer
default:50

Page size, from 1 to 100. Values outside this range are adjusted to the nearest limit.

Required range: 1 <= x <= 100

Response

Recipients returned successfully.

status
number
Example:

0

message
string
Example:

"success"

recipients
object[]
page
integer
Example:

0

size
integer
Example:

50

totalPages
integer
Example:

1

totalRecipients
integer
Example:

2