Campaign API v1 documentation

API Usage

This page provides a high-level overview of the API and guidance on how to access, authenticate, and request support. It is intended as a reference point for developers and users who need to integrate with the API.

Capabilities

• Data retrieval – fetch structured data from the system.

• Data submission – send and store data into the platform.

• Schema definition – provides information on request/response objects, parameters, query strings, and headers.

• Configuration access – interact with specific configurations and settings.

• Monitoring & Diagnostics – review statuses, logs, and operational information.

• “Try It Out” feature – execute real API requests directly from the UI.

For full details on all endpoints, see the Swagger UI.

Where to find endpoints

All available endpoints are documented in Swagger:

The Swagger UI allows you to:

• Browse the list of endpoints.

• Review request/response schemas.

• Test endpoints directly in the browser.

Where to find Swagger

Swagger is publicly accessible under:

To gain access to the interactive aspects of Swagger such as executing requests, please contact Support.

OpenAPI Specification

In addition to the interactive Swagger UI, the raw OpenAPI v3 specification can be retrieved in human-readable format (JSON).

• URL:

  https://{customer-url}/api/v3/api-docs/campaign-api

• This file defines:

  • All endpoints, parameters, and request/response schemas

  • Authentication requirements

  • Metadata (titles, descriptions, tags)

• Typical use cases:

  • Import into Postman to quickly generate a workspace.

  • Client SDK generation via tools like Swagger Codegen or OpenAPI Generator.

  • Validation & automation as part of CI/CD pipelines.

Sending request with Keycloak authentication

• Ensure the Use-Keycloak-Auth header is included and set to true (default value)

Once done, you can test endpoints directly in Swagger. (Provided you have the proper access.)