List campaigns

List campaigns.

GET /campaigns

List campaigns

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/campaigns/campaigns \
  --header 'apikey: <api-key>' \
  --header 'appid: <appid>'

Authorizations

apikey · string · header · required

Your CometChat REST API Key.

Headers

appid · string · required

Tenant application ID

Query Parameters

updatedAt · number

Cursor: updatedAt unix timestamp of last item

id · string

Cursor: id of last item

affix · enum<string>

Cursor direction

Available options: append, prepend

limit · number · default: 20

Items per page

Required range: 1 <= x <= 100

sort · enum<string>

Sort field

Available options: updatedAt, createdAt, name

order · enum<string>

Sort direction

Available options: asc, desc

status · string

Filter by campaign status

search · string

Search by name

Response

200

Campaign list