List campaigns (tenant:crm:read)
GET /api/crm/v1/campaigns
Module: CRM · operationId: listCampaigns · Tag: Campaigns · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
status |
query | CampaignStatus | (one of PLANNING, ACTIVE, COMPLETED, CANCELLED) |
|
type |
query | CampaignType | (one of EMAIL, WEBINAR, TRADE_SHOW, ADS, EVENT, SOCIAL_MEDIA, OTHER) |
|
search |
query | string | Case-insensitive substring of name or description. (max length 255) | |
sort |
query | string | Sort order: a field for ascending, -field for descending. Fields: createdAt, updatedAt, name, startDate, endDate, budget, actualCost, status. Default -createdAt. Unknown values answer 400 (invalid_sort). (max length 32) |
|
limit |
query | integer | Page size, 1–200 (default 50); any other value is 400 invalid. (default 50; max 200) |
|
cursor |
query | string | nextCursor of the previous page; leave out for the first page. Keep sort and the filters unchanged while paging: a cursor of another sort or an altered one is 400 invalid (field: cursor). (max length 1024) |
Responses
- 200 A page of campaigns and the total number of matching campaigns (
application/json) - 400 Invalid input (
invalid):fieldnames the first invalid field,details.fieldsevery one (JSON paths for bodies, parameter names for the query). Some refusals have their own code (invalid_sort,invalid_stages,invalid_custom_fields,convert_target_required,invalid_csv, …). (application/json) - 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission (
insufficient permissions) or has no active tenant. (application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 200 answer:
items(array of Campaign, required): One page of campaigns.actualCost(number (double), required): Cost so far.budget(number (double), required): Planned budget.createdAt(string (date-time), required): Creation time.customerNo(string, required): Customer number of the tenant.id(string (uuid), required): Id of the campaign.name(string, required): Name of the campaign.status(CampaignStatus, required): (one ofPLANNING,ACTIVE,COMPLETED,CANCELLED)tenantName(string, required): Tenant name.type(CampaignType, required): (one ofEMAIL,WEBINAR,TRADE_SHOW,ADS,EVENT,SOCIAL_MEDIA,OTHER)updatedAt(string (date-time), required): Time of the last change.description(string): Omitted when not set.endDate(string (date-time)): Omitted when not set.startDate(string (date-time)): Omitted when not set.
total(integer, required): Number of all records matching the filters.nextCursor(string): Cursor of the next page (pass it ascursor); missing on the last page.
Example 200 answer:
{
"items": [
{
"actualCost": 11340,
"budget": 12000,
"createdAt": "2026-04-16T14:00:00Z",
"customerNo": "99999",
"description": "Gemeinschaftsstand mit Nordlicht IT-Distribution auf der regionalen IT-Messe; Schwerpunkt Netzwerk, WLAN und Managed Services.",
"endDate": "2026-07-20T00:00:00Z",
"id": "2a4c6e8a-0b2d-4f4a-8c6e-8a0c2e4a6c8e",
"name": "Messe IT-Business Ostbayern",
"startDate": "2026-07-18T00:00:00Z",
"status": "COMPLETED",
"tenantName": "DEMO",
"type": "TRADE_SHOW",
"updatedAt": "2026-08-18T09:00:00Z"
}
],
"total": 1
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/campaigns' \
-H "Authorization: Bearer $ACCESS_TOKEN"