Get a campaign (tenant:crm:read)
GET /api/crm/v1/campaigns/{id}
Module: CRM · operationId: getCampaign · Tag: Campaigns · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string (uuid) | yes | Record ID (UUID). |
Responses
- 200 The campaign (
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) - 404 The record does not exist in the token's tenant. (
application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 200 answer:
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.
Example 200 answer:
{
"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"
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/campaigns/3f2b8c1e-6d4a-4f7b-9a2e-1c5d7e9f0a12' \
-H "Authorization: Bearer $ACCESS_TOKEN"