Skip to main content
GET
List 10DLC Campaigns

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

name
string

Filters Campaigns by name. Matches partial values.

Example:

"Name"

usecase
string

Filters Campaigns by use case.

Example:

"2FA"

status
string

Filters Campaigns by status.

Example:

"APPROVED"

mock
boolean
default:false

When true, returns only mock Campaigns used for testing. Default false.

Example:

true

created_before
string<date>

Returns Campaigns created on or before this date, in YYYY-MM-DD format.

Example:

"2024-08-22"

created_after
string<date>

Returns Campaigns created on or after this date, in YYYY-MM-DD format.

Example:

"2024-08-22"

page
integer<int32>

Page number to retrieve. Default 1.

Example:

1

per_page
integer<int32>

Number of records to return per page. Default 25.

Example:

25

Response

Returns a paginated list of 10DLC Campaigns.

Paginated list of 10DLC Campaigns.

items
TenDLCCampaign · object[]
required

10DLC Campaigns on the current page that match the filter criteria.

pagination
Pagination · object
required

Pagination metadata for the result set.