Campaign Customers

List campaign customers

Returns customers for a campaign with retry status, property keys, pagination, and exports.

get/campaign/{campaignId}/customers

Request

  • Base URL
    https://app.freyavoice.ai/api/v2
  • Auth
    HTTP bearer

Path parameters

campaignIdstring uuid required

Campaign ID

Query parameters

workspaceIdstring uuid required

Workspace ID

limitstring

Page size

offsetstring

Offset for pagination

filtersstring

Base64-encoded filter state

searchstring

Global search term

sortBystring

Sort field name

sortOrder'asc' | 'desc'

Sort direction

exportstring

Set to 'true' to return a file export

exportFormat'csv' | 'xlsx' | 'markdown'

Export file format

exportColumnsstring

JSON array of column definitions {id,label}

Response

Customers with pagination

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.