Skip to main content
GET
List calls

Authorizations

X-Api-Key
string
header
required

Your API key.

Query Parameters

agentId
string<uuid>

Filter by agent id

phone
string

Filter by phone number, in the E.164 international standard format

Example:

"+33612345678"

campaignName
string

Filter by campaign name

from
string

Filter by date, inclusive lower bound. Requires 'to' to not be null.

Format: YYYY-MM-DD

Example:

"2024-08-01"

to
string

Filter by date, inclusive upper bound. Requires 'from' to not be null.

Format: YYYY-MM-DD

Example:

"2024-08-31"

page
string
default:1

The page number to be returned, starts at 1

size
string
default:25

The number of items to be returned, maximum 100

sort
enum<string>

The sort property and direction

Available options:
<property>,ASC,
<property>,DESC
Example:

"property,DESC"

Response

OK

content
object[]

List of items in the current page

size
integer<int32>

The size of the page

page
integer<int32>

The page number

totalElements
integer<int64>

The total amount of elements

totalPages
integer<int32>

The number of total pages