# Campaign API v1 documentation

### API Usage

This page provides an overview of the API, as well as guidance on how to access it, how to authenticate and how to request support. It is intended as a point of reference 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 on 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:

[![afbeelding.png](https://documentation.adhese.org/uploads/images/gallery/2025-10/scaled-1680-/JnECwCbcasmfYHVX-afbeelding.png)](https://documentation.adhese.org/uploads/images/gallery/2025-10/JnECwCbcasmfYHVX-afbeelding.png)

The Swagger UI allows you to:

<div class="rich-media-item mediaSingleView-content-wrap image-center cc-1uj41td" data-media-vc-wrapper="true" data-node-type="mediaSingle" data-renderer-start-pos="846" data-vc="media-single" data-width="1441" data-width-type="pixel" id="bkmrk--1"></div>- Browse the list of endpoints.
- Review request/response schemas.
- Test endpoints directly in the browser.

### Where to find Swagger

Swagger is publicly accessible under:

<div class="code-block cc-19e6trp" id="bkmrk-https%3A%2F%2F%7Bcustomer-ur"><span class="prismjs _2rko12b0 _1dqoglyw _1wyb1crf _k48pi7a9 _1e0c1txw _vwz4gktf _1reo1wug _o572qvpr _1eimjvyg _bfhktkvp _syaz1fxt _ect41odn _1ozdn7od _7xinn7od _t7aun7od _r28du2gc _tajqu2gc _1ohiu2gc _m802u2gc _i6ntu2gc _1w2xu2gc _1hmyegat _vblregat _vbulegat _196q1xv3 _1vbw1xv3 _1v9c1xv3 _1srn17d7 _18r6myb0 _vyvc1n1a _1d4j1y44 _1f8gstnw _1pzyb3bt _ra6gww7y _13cdh2mm _1pp0126e _zvy9f705 _qcxof705 _qzn01a66 _j0l11wug _1weckb7n _1na21hna _vsnzgrf3 _x7c815vq _lh0y15vq _1m3815vq _qk1e15vq _12l6ysn8 _uga3ysn8 _mx8b7mnp _1kr87mnp _xo19t94y _1bemt94y _nalpstnw _151dstnw _1exb1q9c _1hgu1q9c _1mgnt94y _nhket94y _h909m7j4 _scgayz1z _ipl81e17 _40uk1l04 _i81p1a66 _1gx21e5h _1ls01ule _vm2c1rh5 _12ok1rh5 _rude1ule _1q16glyw _1io6glyw _juomusic _lcwuusic _pyovu2gc _ccm6u2gc _1ascu2gc _1yuau2gc _xr0w1a66 _4io21a66 _euyxusvi _cahfusvi _zhnuidpf _1amdidpf _mbgcpf9b _bu7zpf9b _131n1giz _gy101giz _1wfuwrk5 _16kzwrk5 _9kk3moej _cjus1w1g _9k2r1m30 _nhmw1m30 _yl021m30 _eiht5x2v _t9zb5x2v _mqok1w1g _3hsg1w1g _i7ngn7od _9wu1fb2s _1xcoh55r _1t361fxt _137bh55r _1k7d1fxt _97lipnps _12nh9lu1 _1g0517qg _i2ig10m5 _326z1fxt _113p131l _1n6tpnps _tgu817qg _1k47pnps _g0lx1fxt _ys4e131l _7gp8h55r _1yvq10m5 _1vww10m5 _1rju10m5 _1v0lh55r _wmyy17qg _748n17qg _1mfn17qg _1d7e17qg _p2vr17qg _19o610m5 _kxov17qg _1np517qg _m2f517qg _1b9tpnps _1tq6pnps _1rd2pnps _1pbkpnps _k3lipnps _13zt131l _2g12fb2s _k86b10m5 _b5iy131l _gti3131l _1f0gpnps _9d3e17qg _qdiapnps _72uvpnps _13dgkb7n _17071olh _1i3h1txw _16noidpf _h4fuidpf _pp6yidpf _1g4tidpf _11wmidpf _1bx8idpf" data-code-lang="" data-ds--code--code-block="" data-testid="renderer-code-block" style="--ads-code-line-number-width: calc(1ch + 16px); --ads-highlighted-start-text: Highlight start; --ads-highlighted-end-text: Highlight end;">`<span class="" data-ds--code--row="" data-testid="renderer-code-block-line-1"><span class="">https://{customer-url}/swagger-ui/index.html</span></span>`</span></div><p class="callout warning">To access Swagger's interactive features, such as executing requests, please [contact Support](https://documentation.adhese.org/books/introduction/page/adhese-support).</p>

### OpenAPI Specification

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

- URL:
    
    <span class="prismjs _2rko12b0 _1dqoglyw _1wyb1crf _k48pi7a9 _1e0c1txw _vwz4gktf _1reo1wug _o572qvpr _1eimjvyg _bfhktkvp _syaz1fxt _ect41odn _1ozdn7od _7xinn7od _t7aun7od _r28du2gc _tajqu2gc _1ohiu2gc _m802u2gc _i6ntu2gc _1w2xu2gc _1hmyegat _vblregat _vbulegat _196q1xv3 _1vbw1xv3 _1v9c1xv3 _1srn17d7 _18r6myb0 _vyvc1n1a _1d4j1y44 _1f8gstnw _1pzyb3bt _ra6gww7y _13cdh2mm _1pp0126e _zvy9f705 _qcxof705 _qzn01a66 _j0l11wug _1weckb7n _1na21hna _vsnzgrf3 _x7c815vq _lh0y15vq _1m3815vq _qk1e15vq _12l6ysn8 _uga3ysn8 _mx8b7mnp _1kr87mnp _xo19t94y _1bemt94y _nalpstnw _151dstnw _1exb1q9c _1hgu1q9c _1mgnt94y _nhket94y _h909m7j4 _scgayz1z _ipl81e17 _40uk1l04 _i81p1a66 _1gx21e5h _1ls01ule _vm2c1rh5 _12ok1rh5 _rude1ule _1q16glyw _1io6glyw _juomusic _lcwuusic _pyovu2gc _ccm6u2gc _1ascu2gc _1yuau2gc _xr0w1a66 _4io21a66 _euyxusvi _cahfusvi _zhnuidpf _1amdidpf _mbgcpf9b _bu7zpf9b _131n1giz _gy101giz _1wfuwrk5 _16kzwrk5 _9kk3moej _cjus1w1g _9k2r1m30 _nhmw1m30 _yl021m30 _eiht5x2v _t9zb5x2v _mqok1w1g _3hsg1w1g _i7ngn7od _9wu1fb2s _1xcoh55r _1t361fxt _137bh55r _1k7d1fxt _97lipnps _12nh9lu1 _1g0517qg _i2ig10m5 _326z1fxt _113p131l _1n6tpnps _tgu817qg _1k47pnps _g0lx1fxt _ys4e131l _7gp8h55r _1yvq10m5 _1vww10m5 _1rju10m5 _1v0lh55r _wmyy17qg _748n17qg _1mfn17qg _1d7e17qg _p2vr17qg _19o610m5 _kxov17qg _1np517qg _m2f517qg _1b9tpnps _1tq6pnps _1rd2pnps _1pbkpnps _k3lipnps _13zt131l _2g12fb2s _k86b10m5 _b5iy131l _gti3131l _1f0gpnps _9d3e17qg _qdiapnps _72uvpnps _13dgkb7n _17071olh _1i3h1txw _16noidpf _h4fuidpf _pp6yidpf _1g4tidpf _11wmidpf _1bx8idpf" data-code-lang="" data-ds--code--code-block="" data-testid="renderer-code-block" style="--ads-code-line-number-width: calc(1ch + 16px); --ads-highlighted-start-text: Highlight start; --ads-highlighted-end-text: Highlight end;">`<span class="" data-ds--code--row="" data-testid="renderer-code-block-line-1"><span class="">https://{customer-url}/api/v3/api-docs/campaign-api</span></span>`</span>
- 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 &amp; automation** as part of CI/CD pipelines.

### Sending a request with Keycloak authentication

- Ensure the **Use-Keycloak-Auth** header is included and set to `true` (default value)[![afbeelding.png](https://documentation.adhese.org/uploads/images/gallery/2025-10/scaled-1680-/fhIEdidyz8hBv37L-afbeelding.png)](https://documentation.adhese.org/uploads/images/gallery/2025-10/fhIEdidyz8hBv37L-afbeelding.png)

<div class="rich-media-item mediaSingleView-content-wrap image-center cc-1di80mj" data-media-vc-wrapper="true" data-node-type="mediaSingle" data-renderer-start-pos="2502" data-vc="media-single" data-width="541" data-width-type="pixel" id="bkmrk-optional-field-with%C2%A0"><div class="cc-1b21syk"><div data-alt="Screenshot 2025-09-30 at 14.27.18.jpg" data-collection="contentId-2888171524" data-context-id="2888171524" data-file-mime-type="image/jpeg" data-file-name="Screenshot 2025-09-30 at 14.27.18.jpg" data-file-size="9361" data-height="112" data-id="4336be42-66a8-4346-b664-73b60e382e26" data-node-type="media" data-renderer-start-pos="2503" data-type="file" data-width="541"><div class="_2rko12b0 _vchhusvi _kqswh2mm _ect41gqc _p12f1osq _c71l1osq _1bsb1qmm _4t3ine4n _1hlmi3bv _1rquusvi _eg5410xm _mts3kb7n _1ntskb7n _80omtlke new-file-experience-wrapper" data-media-vc-wrapper="true" data-testid="media-card-view" id="bkmrk-optional-field-with%C2%A0-1" style="--media-wrapper-width: 1310px; --media-wrapper-height: 271.2014787430684px; font-size: 14px; line-height: 22px;"><div class="_1reo15vq _18m915vq _2rko12b0 _1e0c1txw _kqswh2mm _p12f1osq _1bsb1osq _4t3i1osq _c71l1osq media-file-card-view" data-test-media-name="Screenshot 2025-09-30 at 14.27.18.jpg" data-test-progress="1" data-test-source="cache-remote" data-test-status="complete" data-testid="media-file-card-view"><div class="_kqswstnw _1bsb1osq _4t3i1osq _1e0c1txw _2lx21bp4 _1bah1h6o _4cvr1h6o" data-testid="ImageRendererWrapper">- optional field with **api-version** header should be left empty

</div></div></div></div></div></div>Once ready, you can test the endpoints directly in Swagger (provided you have the necessary permissions).