Skip to main content
GET
Get campaigns

Authorizations

x-api-key
string
header
required

Query Parameters

page
string
default:1

Page number for pagination. Minimum value is 1. Defaults to 1.

pageSize
string
default:25

Number of items per page. Minimum is 1, maximum is 100. Defaults to 25.

Search term to filter campaigns by name (case-insensitive).

identitySenderId
string

Filter campaigns by sender identity ID.

status
enum<string>

Filter campaigns by status.

Available options:
ACTIVE,
PENDING,
DRAFT,
COMPLETED

Response

200 - application/json

Successful response with paginated campaigns

data
object[]
required
meta
object
required