List campaigns (filtered/paged)

POST

https://api.veloconnect.me/api/v2/campaigns/query

Campaigns (v2)

Last modified:2026-07-17 08:27:15

Returns a paged, filtered list of the caller's campaigns. Same filters as Export campaigns - use this to browse campaigns in a table/dashboard.

Authentication: Authorization: Bearer <JWT> (obtain via Partner login, refresh via Refresh token).

Body fields

pageNumber (integer, default 1) - 1-based page index.

pageSize (integer, 1-1000, default 20) - records per page.

search (string, optional) - free-text filter matched against the campaign name (case-insensitive, partial).

status (string, optional) - filter by campaign status; omit to include all statuses.

providerType (string, optional) - filter by channel/provider type (e.g. Sms, Viber, Whatsapp); omit for all.

channelsUsed (string[], optional) - restrict to campaigns that use these channels; combined per channelFilterMode.

channelFilterMode (string, optional) - "ALL" = campaign must use exactly these channels (all present, none extra); any other value or omitted = match campaigns using any of them.

sortBy (string, optional) - one of name, status, scheduleDate, modifiedAt, createdAt; unknown/omitted defaults to createdAt.

sortDescending (boolean, default true) - true = descending, false = ascending.

Example request

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

cURLHttpiewget

curl --location 'https://api.veloconnect.me/api/v2/campaigns/query' \
--header 'Content-Type: application/json' \
--data '{
    "pageNumber": 0,
    "pageSize": 0,
    "search": "string",
    "status": "string",
    "providerType": "string",
    "channelsUsed": [
        "string"
    ],
    "channelFilterMode": "string",
    "sortBy": "string",
    "sortDescending": true
}'

Response Example

200 - Success Example

{
    "data": [
        {
            "items": [
                {
                    "id": null,
                    "businessId": null,
                    "name": null,
                    "status": null,
                    "scheduleDate": null,
                    "timezone": null,
                    "timezoneId": null,
                    "createdAt": null,
                    "modifiedAt": null,
                    "totalRecipientsCount": null,
                    "totalAttemptedCount": null,
                    "totalSentCount": null,
                    "totalDeliveredCount": null,
                    "totalFailedCount": null,
                    "totalSkippedCount": null,
                    "deliveryRate": null,
                    "totalPrice": null,
                    "totalCost": null,
                    "currency": null,
                    "totalClicks": null,
                    "uniqueClicks": null,
                    "ctr": null,
                    "channelsUsedSummary": null,
                    "channels": null
                }
            ],
            "totalCount": 0,
            "pageSize": 0,
            "pageNumber": 0
        }
    ]
}

Modified at 2026-07-17 08:27:15

Export campaigns

Get campaign details