Skip to main content
GET
/
campaign
/
{campaignId}
/
customers
List campaign customers
curl --request GET \
  --url https://app2.freyavoice.ai/api/v2/campaign/{campaignId}/customers \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "customers": [
        {
          "id": "<string>",
          "phoneNumber": "<string>",
          "properties": {},
          "retryStatus": {
            "status": "pending",
            "attempts": 123,
            "lastAttemptAt": "2023-11-07T05:31:56Z",
            "nextRetryAt": "2023-11-07T05:31:56Z",
            "callIds": [
              "<string>"
            ]
          },
          "callCount": 123,
          "createdAt": "<string>"
        }
      ],
      "propertyKeys": [
        "<string>"
      ],
      "pagination": {
        "total": 123,
        "limit": 123,
        "offset": 123
      },
      "statusCounts": {}
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string<uuid>
required

Campaign ID

Minimum string length: 1

Query Parameters

workspaceId
string<uuid>
required

Workspace ID

Minimum string length: 1
limit
string
default:25

Page size

offset
string
default:0

Offset for pagination

filters
string

Base64-encoded filter state

Global search term

sortBy
string

Sort field name

sortOrder
enum<string>

Sort direction

Available options:
asc,
desc
export
string

Set to 'true' to return a file export

exportFormat
enum<string>

Export file format

Available options:
csv,
xlsx,
markdown
exportColumns
string

JSON array of column definitions {id,label}

Response

Customers with pagination

success
enum<boolean>
required
Available options:
true,
false
data
object
required