API ReferenceCampaignsToll-Free

List Toll-Free Campaigns

List all toll-free campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
pageIndexintegerOptional>=0Defaults to 0
pageSizeintegerOptional1-100Defaults to 20
statusenumOptional
Allowed values:
brandIdstringOptional
namestringOptional

Filter by campaign name (partial match, case-insensitive).

Response

Returns paginated list of toll-free campaigns.

datalist of objects
hasMoreboolean
countinteger

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error