White Label APIs

Lightweight health check for Security Audit. Verifies the feature is enabled for this White Label and that the token includes security-audit:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "security-audit"
  }
}

List settings for Security Audit, optionally filtered by query params. Path: settings.

Expected: Native admin JSON list or payload for settings (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Partially update a settings in Security Audit. Send only the fields to change. Path: settings.

Expected: Native admin JSON for the updated settings. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fetch analytics for Security Audit (analytics).

Expected: Native admin JSON list or payload for analytics (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List analytics for Security Audit, optionally filtered by query params. Path: analytics/periods.

Expected: Native admin JSON list or payload for periods (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Reset analytics in Security Audit. Send a JSON body as required by the admin API. Path: analytics/reset.

Expected: Native admin JSON for the created reset (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Run Security Audit. Send a JSON body as required by the admin API. Path: run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Create a new run github in Security Audit. Send the native admin JSON body. Path: run-github.

Expected: Native admin JSON for the created run github (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new run archive in Security Audit. Send the native admin JSON body. Path: run-archive.

Expected: Native admin JSON for the created run archive (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new kubeconfig in Security Audit. Send the native admin JSON body. Path: kubeconfig.

Expected: Native admin JSON for the created kubeconfig (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List reports for Security Audit, optionally filtered by query params. Path: reports.

Expected: Native admin JSON list or payload for reports (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List reports for Security Audit, optionally filtered by query params. Path: reports/mapped.

Expected: Native admin JSON list or payload for mapped (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fetch overview for a specific overview in Security Audit (reports/{id}/overview).

Expected: Native admin JSON list or payload for overview (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one sbom (and related fields) from Security Audit by id. Path: reports/{id}/sbom.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one audit mapped.pdf (and related fields) from Security Audit by id. Path: reports/{id}/export/audit-mapped.pdf.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one audit.pdf (and related fields) from Security Audit by id. Path: reports/{id}/export/audit.pdf.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one ai recommendations.pdf (and related fields) from Security Audit by id. Path: reports/{id}/export/ai-recommendations.pdf.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one mr7 analysis.pdf (and related fields) from Security Audit by id. Path: reports/{id}/export/mr7-analysis.pdf.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one defectdojo.json (and related fields) from Security Audit by id. Path: reports/{id}/export/defectdojo.json.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Create a nested resource or trigger an action on rerun mr7 in Security Audit. Path: reports/{id}/rerun-mr7.

Expected: Native admin JSON for the created rerun mr7 (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Pause this pause in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/pause.

Expected: Native admin JSON for the created pause (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Resume this resume in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/resume.

Expected: Native admin JSON for the created resume (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Cancel this cancel in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/cancel.

Expected: Native admin JSON for the created cancel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Run this run in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/mapping/run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Check status of a specific statu in Security Audit (reports/{id}/mapping/status).

Expected: Native admin JSON list or payload for statu (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one issue (and related fields) from Security Audit by id. Path: reports/{id}/mapping/issues/{mappedIssueId}.

Expected: Native admin JSON for one issue (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one issue (and related fields) from Security Audit by id. Path: reports/{id}/mapping/issues.

Expected: Native admin JSON list or payload for issue (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List workflow for Security Audit, optionally filtered by query params. Path: workflow/templates.

Expected: Native admin JSON list or payload for templates (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List workflow for Security Audit, optionally filtered by query params. Path: workflow/node-palette.

Expected: Native admin JSON list or payload for node palette (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one field option (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery/field-options.

Expected: Native admin JSON list or payload for field option (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Test this test in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/workflow/ak-bakery/nodes/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Retrieve one webhook (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery/webhook/{nodeId}.

Expected: Native admin JSON for one webhook (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on webhook in Security Audit. Path: reports/{id}/workflow/ak-bakery/webhook/{nodeId}.

Expected: Native admin JSON for the created webhook (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on probe in Security Audit. Path: reports/{id}/workflow/ak-bakery/webhook/{nodeId}/probe.

Expected: Native admin JSON for the created probe (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one export (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery/runs/{runId}/exports/{exportId}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one run (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery/runs.

Expected: Native admin JSON list or payload for run (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one run (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery/runs/{runId}.

Expected: Native admin JSON for one run (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Check status of a specific statu in Security Audit (reports/{id}/workflow/ak-bakery/status).

Expected: Native admin JSON list or payload for statu (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on reset default in Security Audit. Path: reports/{id}/workflow/ak-bakery/reset-default.

Expected: Native admin JSON for the created reset default (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Pause this pause in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/workflow/ak-bakery/run/pause.

Expected: Native admin JSON for the created pause (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Resume this resume in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/workflow/ak-bakery/run/resume.

Expected: Native admin JSON for the created resume (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Cancel this cancel in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/workflow/ak-bakery/run/cancel.

Expected: Native admin JSON for the created cancel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on load in Security Audit. Path: reports/{id}/workflow/ak-bakery/templates/{templateId}/load.

Expected: Native admin JSON for the created load (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one ak bakery (and related fields) from Security Audit by id. Path: reports/{id}/workflow/ak-bakery.

Expected: Native admin JSON list or payload for ak bakery (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a ak bakery in Security Audit. Send the complete resource payload. Path: reports/{id}/workflow/ak-bakery.

Expected: Native admin JSON for the updated ak bakery. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Run this run in Security Audit. Send a JSON body as required by the admin API. Path: reports/{id}/workflow/ak-bakery/run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Retrieve one issue (and related fields) from Security Audit by id. Path: reports/{id}/issues.

Expected: Native admin JSON list or payload for issue (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one ai (and related fields) from Security Audit by id. Path: reports/{id}/issues/{issueId}/ai.

Expected: Native admin JSON list or payload for ai (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on ask ai in Security Audit. Path: reports/{id}/issues/{issueId}/ask-ai.

Expected: Native admin JSON for the created ask ai (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one issue (and related fields) from Security Audit by id. Path: reports/{id}/issues/{issueId}.

Expected: Native admin JSON for one issue (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Partially update a issue in Security Audit. Send only the fields to change. Path: reports/{id}/issues/{issueId}.

Expected: Native admin JSON for the updated issue. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Retrieve one report (and related fields) from Security Audit by id. Path: reports/{id}.

Expected: Native admin JSON for one report (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one statu (and related fields) from Security Audit by id. Path: status/{id}.

Expected: Native admin JSON for one statu (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a clone from Security Audit. Path: reports/{id}/clone.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Permanently delete a report from Security Audit. Path: reports/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for Website Analyzer. Verifies the feature is enabled for this White Label and that the token includes website-analyzer:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "website-analyzer"
  }
}

Analyze Website Analyzer. Send a JSON body as required by the admin API. Path: analyze.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List reports for Website Analyzer, optionally filtered by query params. Path: reports.

Expected: Native admin JSON list or payload for reports (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one report (and related fields) from Website Analyzer by id. Path: reports/{id}.

Expected: Native admin JSON for one report (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a report from Website Analyzer. Path: reports/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Partially update a note in Website Analyzer. Send only the fields to change. Path: reports/{id}/notes.

Expected: Native admin JSON for the updated note. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Retrieve one pdf (and related fields) from Website Analyzer by id. Path: reports/{id}/pdf.

Expected: Native admin JSON list or payload for pdf (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on competitor in Website Analyzer. Path: reports/{id}/competitors.

Expected: Native admin JSON for the created competitor (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on backlink in Website Analyzer. Path: reports/{id}/backlinks.

Expected: Native admin JSON for the created backlink (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List settings for Website Analyzer, optionally filtered by query params. Path: settings.

Expected: Native admin JSON list or payload for settings (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Partially update a settings in Website Analyzer. Send only the fields to change. Path: settings.

Expected: Native admin JSON for the updated settings. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List campaign periods for Website Analyzer, optionally filtered by query params. Path: campaign-periods.

Expected: Native admin JSON list or payload for campaign periods (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Lightweight health check for SEO Toolkit. Verifies the feature is enabled for this White Label and that the token includes seo-config:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "seo-config"
  }
}

List or fetch the root SEO Toolkit collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new update in SEO Toolkit. Send the native admin JSON body. Path: update.

Expected: Native admin JSON for the created update (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new add in SEO Toolkit. Send the native admin JSON body. Path: add.

Expected: Native admin JSON for the created add (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new delete in SEO Toolkit. Send the native admin JSON body. Path: delete.

Expected: Native admin JSON for the created delete (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new save all in SEO Toolkit. Send the native admin JSON body. Path: save-all.

Expected: Native admin JSON for the created save all (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new keyword research in SEO Toolkit. Send the native admin JSON body. Path: keyword-research.

Expected: Native admin JSON for the created keyword research (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new keyword intel in SEO Toolkit. Send the native admin JSON body. Path: keyword-intel.

Expected: Native admin JSON for the created keyword intel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new strategy save in SEO Toolkit. Send the native admin JSON body. Path: strategy-save.

Expected: Native admin JSON for the created strategy save (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List strategy reports for SEO Toolkit, optionally filtered by query params. Path: strategy-reports.

Expected: Native admin JSON list or payload for strategy reports (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one strategy report (and related fields) from SEO Toolkit by id. Path: strategy-reports/{id}.

Expected: Native admin JSON for one strategy report (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new content generate in SEO Toolkit. Send the native admin JSON body. Path: content-generate.

Expected: Native admin JSON for the created content generate (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on content save in SEO Toolkit. Path: content-save/{id}.

Expected: Native admin JSON for the created content save (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List ai agent config for SEO Toolkit, optionally filtered by query params. Path: ai-agent-config.

Expected: Native admin JSON list or payload for ai agent config (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new ai agent save in SEO Toolkit. Send the native admin JSON body. Path: ai-agent-save.

Expected: Native admin JSON for the created ai agent save (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new ai agent test in SEO Toolkit. Send the native admin JSON body. Path: ai-agent-test.

Expected: Native admin JSON for the created ai agent test (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new ai content generate in SEO Toolkit. Send the native admin JSON body. Path: ai-content-generate.

Expected: Native admin JSON for the created ai content generate (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a ai agent config from SEO Toolkit. Path: ai-agent-config.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for Media Hub. Verifies the feature is enabled for this White Label and that the token includes media-hub:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "media-hub"
  }
}

List or fetch the root Media Hub collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List statistics for Media Hub, optionally filtered by query params. Path: statistics.

Expected: Native admin JSON list or payload for statistics (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one item (and related fields) from Media Hub by id. Path: {id}.

Expected: Native admin JSON for one item (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Upload Media Hub. Send a JSON body as required by the admin API. Path: upload.

Expected: Native admin JSON for the created upload (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a item in Media Hub. Send the complete resource payload. Path: {id}.

Expected: Native admin JSON for the updated item. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a item from Media Hub. Path: {id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on restore in Media Hub. Path: {id}/restore.

Expected: Native admin JSON for the created restore (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a bulk from Media Hub. Path: bulk.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on usage in Media Hub. Path: {id}/usage.

Expected: Native admin JSON for the created usage (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a usage from Media Hub. Path: {id}/usage.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for Task Manager. Verifies the feature is enabled for this White Label and that the token includes task-manager:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "task-manager"
  }
}

List admins for Task Manager, optionally filtered by query params. Path: admins.

Expected: Native admin JSON list or payload for admins (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List export for Task Manager, optionally filtered by query params. Path: export/example.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

List export for Task Manager, optionally filtered by query params. Path: export/example-milestones.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one project (and related fields) from Task Manager by id. Path: export/projects/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one milestone (and related fields) from Task Manager by id. Path: export/milestones/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one user storie (and related fields) from Task Manager by id. Path: export/user-stories/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one task (and related fields) from Task Manager by id. Path: export/tasks/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one subtask (and related fields) from Task Manager by id. Path: export/subtasks/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one bug (and related fields) from Task Manager by id. Path: export/bugs/{id}.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/project.

Expected: Native admin JSON for the created project (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/milestones.

Expected: Native admin JSON for the created milestones (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/user-stories.

Expected: Native admin JSON for the created user stories (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/tasks.

Expected: Native admin JSON for the created tasks (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/subtasks.

Expected: Native admin JSON for the created subtasks (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in Task Manager. Send the native admin JSON body. Path: import/bugs.

Expected: Native admin JSON for the created bugs (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List projects for Task Manager, optionally filtered by query params. Path: projects.

Expected: Native admin JSON list or payload for projects (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one project (and related fields) from Task Manager by id. Path: projects/{id}.

Expected: Native admin JSON for one project (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new project in Task Manager. Send the native admin JSON body. Path: projects.

Expected: Native admin JSON for the created projects (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a project in Task Manager. Send the complete resource payload. Path: projects/{id}.

Expected: Native admin JSON for the updated project. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a project from Task Manager. Path: projects/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one milestone (and related fields) from Task Manager by id. Path: projects/{projectId}/milestones.

Expected: Native admin JSON list or payload for milestone (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one milestone (and related fields) from Task Manager by id. Path: milestones/{id}.

Expected: Native admin JSON for one milestone (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new milestone in Task Manager. Send the native admin JSON body. Path: milestones.

Expected: Native admin JSON for the created milestones (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a milestone in Task Manager. Send the complete resource payload. Path: milestones/{id}.

Expected: Native admin JSON for the updated milestone. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a milestone from Task Manager. Path: milestones/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one user storie (and related fields) from Task Manager by id. Path: milestones/{milestoneId}/user-stories.

Expected: Native admin JSON list or payload for user storie (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one user storie (and related fields) from Task Manager by id. Path: user-stories/{id}.

Expected: Native admin JSON for one user storie (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new user storie in Task Manager. Send the native admin JSON body. Path: user-stories.

Expected: Native admin JSON for the created user stories (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a user storie in Task Manager. Send the complete resource payload. Path: user-stories/{id}.

Expected: Native admin JSON for the updated user storie. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a user storie from Task Manager. Path: user-stories/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one task (and related fields) from Task Manager by id. Path: user-stories/{userStoryId}/tasks.

Expected: Native admin JSON list or payload for task (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one task (and related fields) from Task Manager by id. Path: tasks/{id}.

Expected: Native admin JSON for one task (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new task in Task Manager. Send the native admin JSON body. Path: tasks.

Expected: Native admin JSON for the created tasks (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a task in Task Manager. Send the complete resource payload. Path: tasks/{id}.

Expected: Native admin JSON for the updated task. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a task from Task Manager. Path: tasks/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one subtask (and related fields) from Task Manager by id. Path: tasks/{taskId}/subtasks.

Expected: Native admin JSON list or payload for subtask (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one subtask (and related fields) from Task Manager by id. Path: subtasks/{id}.

Expected: Native admin JSON for one subtask (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new subtask in Task Manager. Send the native admin JSON body. Path: subtasks.

Expected: Native admin JSON for the created subtasks (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a subtask in Task Manager. Send the complete resource payload. Path: subtasks/{id}.

Expected: Native admin JSON for the updated subtask. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a subtask from Task Manager. Path: subtasks/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one bug (and related fields) from Task Manager by id. Path: bugs/{entityType}/{entityId}.

Expected: Native admin JSON for one bug (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one by id (and related fields) from Task Manager by id. Path: bugs/by-id/{id}.

Expected: Native admin JSON for one by id (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new bug in Task Manager. Send the native admin JSON body. Path: bugs.

Expected: Native admin JSON for the created bugs (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a bug in Task Manager. Send the complete resource payload. Path: bugs/{id}.

Expected: Native admin JSON for the updated bug. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a bug from Task Manager. Path: bugs/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one attachment (and related fields) from Task Manager by id. Path: attachments/{entityType}/{entityId}.

Expected: Native admin JSON for one attachment (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on attachment in Task Manager. Path: attachments/{entityType}/{entityId}.

Expected: Native admin JSON for the created attachment (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a attachment from Task Manager. Path: attachments/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one comment (and related fields) from Task Manager by id. Path: comments/{entityType}/{entityId}.

Expected: Native admin JSON for one comment (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on comment in Task Manager. Path: comments/{entityType}/{entityId}.

Expected: Native admin JSON for the created comment (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a comment from Task Manager. Path: comments/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for API Mock Server. Verifies the feature is enabled for this White Label and that the token includes api-mock-server:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "api-mock-server"
  }
}

Fetch overview for API Mock Server (overview).

Expected: Native admin JSON list or payload for overview (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Generate demo data for API Mock Server. Send a JSON body as required by the admin API. Path: demo.

Expected: Native admin JSON for the created demo (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List servers for API Mock Server, optionally filtered by query params. Path: servers.

Expected: Native admin JSON list or payload for servers (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new server in API Mock Server. Send the native admin JSON body. Path: servers.

Expected: Native admin JSON for the created servers (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Import servers in API Mock Server. Send a JSON body as required by the admin API. Path: servers/import.

Expected: Native admin JSON for the created import (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one server (and related fields) from API Mock Server by id. Path: servers/{id}.

Expected: Native admin JSON for one server (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a server in API Mock Server. Send the complete resource payload. Path: servers/{id}.

Expected: Native admin JSON for the updated server. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a server from API Mock Server. Path: servers/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one route (and related fields) from API Mock Server by id. Path: servers/{serverId}/routes.

Expected: Native admin JSON list or payload for route (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on route in API Mock Server. Path: servers/{serverId}/routes.

Expected: Native admin JSON for the created route (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a route in API Mock Server. Send the complete resource payload. Path: routes/{id}.

Expected: Native admin JSON for the updated route. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a route from API Mock Server. Path: routes/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one rule (and related fields) from API Mock Server by id. Path: routes/{routeId}/rules.

Expected: Native admin JSON list or payload for rule (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on rule in API Mock Server. Path: routes/{routeId}/rules.

Expected: Native admin JSON for the created rule (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a rule in API Mock Server. Send the complete resource payload. Path: rules/{id}.

Expected: Native admin JSON for the updated rule. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a rule from API Mock Server. Path: rules/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one log (and related fields) from API Mock Server by id. Path: servers/{serverId}/logs.

Expected: Native admin JSON list or payload for log (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one log (and related fields) from API Mock Server by id. Path: logs/{id}.

Expected: Native admin JSON for one log (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on create rule in API Mock Server. Path: logs/{id}/create-rule.

Expected: Native admin JSON for the created create rule (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fetch analytics for a specific analytic in API Mock Server (servers/{serverId}/analytics).

Expected: Native admin JSON list or payload for analytic (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List snippets for a specific snippet in API Mock Server (servers/{serverId}/snippets).

Expected: Native admin JSON list or payload for snippet (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Test rules in API Mock Server. Send a JSON body as required by the admin API. Path: rules/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Retrieve one state (and related fields) from API Mock Server by id. Path: servers/{serverId}/state.

Expected: Native admin JSON list or payload for state (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a state in API Mock Server. Send the complete resource payload. Path: servers/{serverId}/state.

Expected: Native admin JSON for the updated state. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a nested resource or trigger an action on collection in API Mock Server. Path: servers/{serverId}/collections.

Expected: Native admin JSON for the created collection (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a collection from API Mock Server. Path: collections/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one secret (and related fields) from API Mock Server by id. Path: servers/{serverId}/secrets.

Expected: Native admin JSON list or payload for secret (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on secret in API Mock Server. Path: servers/{serverId}/secrets.

Expected: Native admin JSON for the created secret (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a secret from API Mock Server. Path: secrets/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Export a specific export in API Mock Server (servers/{serverId}/export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Import this import in API Mock Server. Send a JSON body as required by the admin API. Path: servers/{serverId}/openapi/import.

Expected: Native admin JSON for the created import (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Export a specific export in API Mock Server (servers/{serverId}/openapi/export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Retrieve one audit (and related fields) from API Mock Server by id. Path: servers/{serverId}/audit.

Expected: Native admin JSON list or payload for audit (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on retention in API Mock Server. Path: servers/{serverId}/retention.

Expected: Native admin JSON for the created retention (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Publish this publish in API Mock Server. Send a JSON body as required by the admin API. Path: servers/{serverId}/publish.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Create a new validate upstream in API Mock Server. Send the native admin JSON body. Path: validate-upstream.

Expected: Native admin JSON for the created validate upstream (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Lightweight health check for Calendar. Verifies the feature is enabled for this White Label and that the token includes calendar:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "calendar"
  }
}

List events for Calendar, optionally filtered by query params. Path: events.

Expected: Native admin JSON list or payload for events (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new event in Calendar. Send the native admin JSON body. Path: events.

Expected: Native admin JSON for the created events (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a event in Calendar. Send the complete resource payload. Path: events/{id}.

Expected: Native admin JSON for the updated event. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a event from Calendar. Path: events/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on notify in Calendar. Path: events/{id}/notify.

Expected: Native admin JSON for the created notify (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Sync Calendar. Send a JSON body as required by the admin API. Path: sync.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List admins for Calendar, optionally filtered by query params. Path: admins.

Expected: Native admin JSON list or payload for admins (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Lightweight health check for Letters. Verifies the feature is enabled for this White Label and that the token includes letters:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "letters"
  }
}

List or fetch the root Letters collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new preview pdf in Letters. Send the native admin JSON body. Path: preview-pdf.

Expected: Native admin JSON for the created preview pdf (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new preview docx in Letters. Send the native admin JSON body. Path: preview-docx.

Expected: Native admin JSON for the created preview docx (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new item in Letters. Send the native admin JSON body. Path: (root).

Expected: Native admin JSON for the created resource (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one pdf (and related fields) from Letters by id. Path: {id}/pdf.

Expected: Native admin JSON list or payload for pdf (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on pdf in Letters. Path: {id}/pdf.

Expected: Native admin JSON for the created pdf (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one docx (and related fields) from Letters by id. Path: {id}/docx.

Expected: Native admin JSON list or payload for docx (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on docx in Letters. Path: {id}/docx.

Expected: Native admin JSON for the created docx (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one item (and related fields) from Letters by id. Path: {id}.

Expected: Native admin JSON for one item (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a item in Letters. Send the complete resource payload. Path: {id}.

Expected: Native admin JSON for the updated item. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a item from Letters. Path: {id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for Proposal Creator. Verifies the feature is enabled for this White Label and that the token includes proposal-creator:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "proposal-creator"
  }
}

List or fetch the root Proposal Creator collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List default structure for Proposal Creator, optionally filtered by query params. Path: default-structure.

Expected: Native admin JSON list or payload for default structure (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new item in Proposal Creator. Send the native admin JSON body. Path: (root).

Expected: Native admin JSON for the created resource (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new upload logo in Proposal Creator. Send the native admin JSON body. Path: upload-logo.

Expected: Native admin JSON for the created upload logo (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on generate pdf in Proposal Creator. Path: {id}/generate-pdf.

Expected: Native admin JSON for the created generate pdf (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one item (and related fields) from Proposal Creator by id. Path: {id}.

Expected: Native admin JSON for one item (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a item in Proposal Creator. Send the complete resource payload. Path: {id}.

Expected: Native admin JSON for the updated item. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a item from Proposal Creator. Path: {id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Lightweight health check for Customer Service. Verifies the feature is enabled for this White Label and that the token includes customer-service:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "customer-service"
  }
}

List ping for Customer Service, optionally filtered by query params. Path: ping.

Expected: Native admin JSON list or payload for ping (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List tickets for Customer Service, optionally filtered by query params. Path: tickets.

Expected: Native admin JSON list or payload for tickets (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List tickets for Customer Service, optionally filtered by query params. Path: tickets/stats.

Expected: Native admin JSON list or payload for stats (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one ticket (and related fields) from Customer Service by id. Path: tickets/{id}.

Expected: Native admin JSON for one ticket (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a ticket in Customer Service. Send the complete resource payload. Path: tickets/{id}.

Expected: Native admin JSON for the updated ticket. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a ticket from Customer Service. Path: tickets/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on message in Customer Service. Path: tickets/{id}/messages.

Expected: Native admin JSON for the created message (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on internal note in Customer Service. Path: tickets/{id}/internal-notes.

Expected: Native admin JSON for the created internal note (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new customer in Customer Service. Send the native admin JSON body. Path: customers.

Expected: Native admin JSON for the created customers (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List customers for Customer Service, optionally filtered by query params. Path: customers.

Expected: Native admin JSON list or payload for customers (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new customer in Customer Service. Send the native admin JSON body. Path: customers/init-tracking.

Expected: Native admin JSON for the created init tracking (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List customers for Customer Service, optionally filtered by query params. Path: customers/init-tracking.

Expected: Native admin JSON list or payload for init tracking (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one tracking config (and related fields) from Customer Service by id. Path: customers/{id}/tracking-config.

Expected: Native admin JSON list or payload for tracking config (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on init tracking in Customer Service. Path: customers/{id}/init-tracking.

Expected: Native admin JSON for the created init tracking (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a tracking config in Customer Service. Send the complete resource payload. Path: customers/{id}/tracking-config/{configId}.

Expected: Native admin JSON for the updated tracking config. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Retrieve one tracking code (and related fields) from Customer Service by id. Path: customers/{id}/tracking-code.

Expected: Native admin JSON list or payload for tracking code (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one iframe key (and related fields) from Customer Service by id. Path: customers/{customerId}/iframe-key.

Expected: Native admin JSON list or payload for iframe key (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on regenerate in Customer Service. Path: customers/{customerId}/iframe-keys/regenerate.

Expected: Native admin JSON for the created regenerate (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one customer (and related fields) from Customer Service by id. Path: customers/{id}.

Expected: Native admin JSON for one customer (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a customer in Customer Service. Send the complete resource payload. Path: customers/{id}.

Expected: Native admin JSON for the updated customer. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a customer from Customer Service. Path: customers/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Fully update / replace a lock in Customer Service. Send the complete resource payload. Path: customers/{id}/lock.

Expected: Native admin JSON for the updated lock. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a active in Customer Service. Send the complete resource payload. Path: customers/{id}/active.

Expected: Native admin JSON for the updated active. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a rate limit in Customer Service. Send the complete resource payload. Path: customers/{id}/rate-limit.

Expected: Native admin JSON for the updated rate limit. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a feature in Customer Service. Send the complete resource payload. Path: customers/{id}/features.

Expected: Native admin JSON for the updated feature. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a task manager project in Customer Service. Send the complete resource payload. Path: customers/{id}/task-manager-projects.

Expected: Native admin JSON for the updated task manager project. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a subscription in Customer Service. Send the complete resource payload. Path: customers/{id}/subscription.

Expected: Native admin JSON for the updated subscription. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a nested resource or trigger an action on notification in Customer Service. Path: customers/{id}/notifications.

Expected: Native admin JSON for the created notification (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one notification (and related fields) from Customer Service by id. Path: customers/{id}/notifications.

Expected: Native admin JSON list or payload for notification (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one payment history (and related fields) from Customer Service by id. Path: customers/{id}/payment-history.

Expected: Native admin JSON list or payload for payment history (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List iframe keys for Customer Service, optionally filtered by query params. Path: iframe-keys.

Expected: Native admin JSON list or payload for iframe keys (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Permanently delete a iframe key from Customer Service. Path: iframe-keys/{keyId}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Fetch analytics for tracking in Customer Service (tracking/analytics).

Expected: Native admin JSON list or payload for analytics (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Lightweight health check for Tracker. Verifies the feature is enabled for this White Label and that the token includes tracker:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "tracker"
  }
}

Create a new visit in Tracker. Send the native admin JSON body. Path: visit.

Expected: Native admin JSON for the created visit (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a visit in Tracker. Send the complete resource payload. Path: visit/{visitId}.

Expected: Native admin JSON for the updated visit. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a new event in Tracker. Send the native admin JSON body. Path: event.

Expected: Native admin JSON for the created event (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new script in Tracker. Send the native admin JSON body. Path: scripts.

Expected: Native admin JSON for the created scripts (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List scripts for Tracker, optionally filtered by query params. Path: scripts.

Expected: Native admin JSON list or payload for scripts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Permanently delete a script from Tracker. Path: scripts/{scriptId}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List pages for Tracker, optionally filtered by query params. Path: pages.

Expected: Native admin JSON list or payload for pages (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one page (and related fields) from Tracker by id. Path: scripts/{scriptId}/pages.

Expected: Native admin JSON list or payload for page (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Assign this assign in Tracker. Send a JSON body as required by the admin API. Path: scripts/{scriptId}/assign.

Expected: Native admin JSON for the created assign (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a assign from Tracker. Path: scripts/{scriptId}/assign.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Partially update a pause in Tracker. Send only the fields to change. Path: scripts/{scriptId}/assign/pause.

Expected: Native admin JSON for the updated pause. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Retrieve one grouped (and related fields) from Tracker by id. Path: visits/{scriptId}/grouped.

Expected: Native admin JSON list or payload for grouped (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one grouped (and related fields) from Tracker by id. Path: events/{scriptId}/grouped.

Expected: Native admin JSON list or payload for grouped (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one visit (and related fields) from Tracker by id. Path: visits/{scriptId}.

Expected: Native admin JSON for one visit (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one event (and related fields) from Tracker by id. Path: events/{scriptId}.

Expected: Native admin JSON for one event (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one analytic (and related fields) from Tracker by id. Path: analytics/{scriptId}.

Expected: Native admin JSON for one analytic (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one map (and related fields) from Tracker by id. Path: map/{scriptId}.

Expected: Native admin JSON for one map (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Lightweight health check for Social Media Manager. Verifies the feature is enabled for this White Label and that the token includes social-media-manager:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "social-media-manager"
  }
}

List scheduler for Social Media Manager, optionally filtered by query params. Path: scheduler/posts.

Expected: Native admin JSON list or payload for posts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Cancel this cancel in Social Media Manager. Send a JSON body as required by the admin API. Path: scheduler/posts/{id}/cancel.

Expected: Native admin JSON for the created cancel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List scheduler for Social Media Manager, optionally filtered by query params. Path: scheduler/logs.

Expected: Native admin JSON list or payload for logs (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one log (and related fields) from Social Media Manager by id. Path: scheduler/logs/{postId}.

Expected: Native admin JSON for one log (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List strategies for Social Media Manager, optionally filtered by query params. Path: strategies.

Expected: Native admin JSON list or payload for strategies (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List strategies for Social Media Manager, optionally filtered by query params. Path: strategies/reminders.

Expected: Native admin JSON list or payload for reminders (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one strategie (and related fields) from Social Media Manager by id. Path: strategies/{id}.

Expected: Native admin JSON for one strategie (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new strategie in Social Media Manager. Send the native admin JSON body. Path: strategies.

Expected: Native admin JSON for the created strategies (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a strategie in Social Media Manager. Send the complete resource payload. Path: strategies/{id}.

Expected: Native admin JSON for the updated strategie. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a strategie from Social Media Manager. Path: strategies/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one task (and related fields) from Social Media Manager by id. Path: strategies/tasks/{taskId}.

Expected: Native admin JSON for one task (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on task in Social Media Manager. Path: strategies/{strategyId}/tasks.

Expected: Native admin JSON for the created task (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a task in Social Media Manager. Send the complete resource payload. Path: strategies/tasks/{taskId}.

Expected: Native admin JSON for the updated task. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a task from Social Media Manager. Path: strategies/tasks/{taskId}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on assign post in Social Media Manager. Path: strategies/tasks/{taskId}/assign-post.

Expected: Native admin JSON for the created assign post (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on remove post in Social Media Manager. Path: strategies/tasks/{taskId}/remove-post.

Expected: Native admin JSON for the created remove post (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one tasks by week (and related fields) from Social Media Manager by id. Path: strategies/{id}/tasks-by-week.

Expected: Native admin JSON list or payload for tasks by week (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one week (and related fields) from Social Media Manager by id. Path: strategies/{id}/week/{weekNumber}.

Expected: Native admin JSON for one week (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List performance for Social Media Manager, optionally filtered by query params. Path: performance/dashboard.

Expected: Native admin JSON list or payload for dashboard (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one strategy (and related fields) from Social Media Manager by id. Path: performance/strategy/{id}.

Expected: Native admin JSON for one strategy (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List performance for Social Media Manager, optionally filtered by query params. Path: performance/trends.

Expected: Native admin JSON list or payload for trends (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new performance in Social Media Manager. Send the native admin JSON body. Path: performance/snapshot.

Expected: Native admin JSON for the created snapshot (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List performance for Social Media Manager, optionally filtered by query params. Path: performance/export/csv.

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Browser-only Social Media Manager flow at oauth/facebook/auth-url. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Browser-only Social Media Manager flow at oauth/instagram/auth-url. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Browser-only Social Media Manager flow at oauth/linkedin/auth-url. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Browser-only Social Media Manager flow at oauth/facebook/callback. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Browser-only Social Media Manager flow at oauth/instagram/callback. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Browser-only Social Media Manager flow at oauth/linkedin/callback. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

List tracking for Social Media Manager, optionally filtered by query params. Path: tracking/public.

Expected: Native admin JSON list or payload for public (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List tracking for Social Media Manager, optionally filtered by query params. Path: tracking.

Expected: Native admin JSON list or payload for tracking (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List tracking for Social Media Manager, optionally filtered by query params. Path: tracking/pages.

Expected: Native admin JSON list or payload for pages (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new tracking in Social Media Manager. Send the native admin JSON body. Path: tracking.

Expected: Native admin JSON for the created tracking (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Test tracking in Social Media Manager. Send a JSON body as required by the admin API. Path: tracking/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List accounts for Social Media Manager, optionally filtered by query params. Path: accounts.

Expected: Native admin JSON list or payload for accounts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one account (and related fields) from Social Media Manager by id. Path: accounts/{id}.

Expected: Native admin JSON for one account (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new account in Social Media Manager. Send the native admin JSON body. Path: accounts.

Expected: Native admin JSON for the created accounts (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a account from Social Media Manager. Path: accounts/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Test this test in Social Media Manager. Send a JSON body as required by the admin API. Path: accounts/{id}/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List posts for Social Media Manager, optionally filtered by query params. Path: posts.

Expected: Native admin JSON list or payload for posts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one post (and related fields) from Social Media Manager by id. Path: posts/{id}.

Expected: Native admin JSON for one post (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new post in Social Media Manager. Send the native admin JSON body. Path: posts.

Expected: Native admin JSON for the created posts (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a post in Social Media Manager. Send the complete resource payload. Path: posts/{id}.

Expected: Native admin JSON for the updated post. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a post from Social Media Manager. Path: posts/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Partially update a statu in Social Media Manager. Send only the fields to change. Path: posts/{id}/status.

Expected: Native admin JSON for the updated statu. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Publish this publish in Social Media Manager. Send a JSON body as required by the admin API. Path: posts/{id}/publish.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Lightweight health check for Platform Ads Manager. Verifies the feature is enabled for this White Label and that the token includes platform-ads-manager:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "platform-ads-manager"
  }
}

List or fetch the root Platform Ads Manager collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Browser-only Platform Ads Manager flow at oauth/{provider}/callback. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

List hub for Platform Ads Manager, optionally filtered by query params. Path: hub.

Expected: Native admin JSON list or payload for hub (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List settings for Platform Ads Manager, optionally filtered by query params. Path: settings.

Expected: Native admin JSON list or payload for settings (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one config (and related fields) from Platform Ads Manager by id. Path: config/{provider}.

Expected: Native admin JSON for one config (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a config in Platform Ads Manager. Send the complete resource payload. Path: config/{provider}.

Expected: Native admin JSON for the updated config. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List capabilities for Platform Ads Manager, optionally filtered by query params. Path: capabilities.

Expected: Native admin JSON list or payload for capabilities (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List connections for Platform Ads Manager, optionally filtered by query params. Path: connections.

Expected: Native admin JSON list or payload for connections (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Browser-only Platform Ads Manager flow at oauth/{provider}/auth-url. Not intended for server-side API tokens; use from a browser redirect.

Expected: HTTP redirect (302/303) to the OAuth provider or callback URL — not a JSON body.

{
  "redirect": true
}

Note: Browser-oriented route — prefer server-side use where possible.

Permanently delete a connection from Platform Ads Manager. Path: connections/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List accounts for Platform Ads Manager, optionally filtered by query params. Path: accounts.

Expected: Native admin JSON list or payload for accounts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List accounts for Platform Ads Manager, optionally filtered by query params. Path: accounts/remote.

Expected: Native admin JSON list or payload for remote (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new account in Platform Ads Manager. Send the native admin JSON body. Path: accounts/link.

Expected: Native admin JSON for the created link (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Partially update a account in Platform Ads Manager. Send only the fields to change. Path: accounts/{id}.

Expected: Native admin JSON for the updated account. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a nested resource or trigger an action on unlink in Platform Ads Manager. Path: accounts/{id}/unlink.

Expected: Native admin JSON for the created unlink (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one billing (and related fields) from Platform Ads Manager by id. Path: accounts/{id}/billing.

Expected: Native admin JSON list or payload for billing (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on billing in Platform Ads Manager. Path: accounts/{id}/billing.

Expected: Native admin JSON for the created billing (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List billing for Platform Ads Manager, optionally filtered by query params. Path: billing.

Expected: Native admin JSON list or payload for billing (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one launch job (and related fields) from Platform Ads Manager by id. Path: launch-jobs/{id}.

Expected: Native admin JSON for one launch job (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new sync in Platform Ads Manager. Send the native admin JSON body. Path: sync/structure.

Expected: Native admin JSON for the created structure (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new sync in Platform Ads Manager. Send the native admin JSON body. Path: sync/metrics.

Expected: Native admin JSON for the created metrics (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fetch overview for analytics in Platform Ads Manager (analytics/overview).

Expected: Native admin JSON list or payload for overview (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one entity (and related fields) from Platform Ads Manager by id. Path: analytics/entity/{type}/{id}.

Expected: Native admin JSON for one entity (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Export analytics in Platform Ads Manager (analytics/export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Create a new ai draft in Platform Ads Manager. Send the native admin JSON body. Path: ai-draft.

Expected: Native admin JSON for the created ai draft (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new creative in Platform Ads Manager. Send the native admin JSON body. Path: creatives.

Expected: Native admin JSON for the created creatives (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List plans for Platform Ads Manager, optionally filtered by query params. Path: plans.

Expected: Native admin JSON list or payload for plans (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one plan (and related fields) from Platform Ads Manager by id. Path: plans/{planId}.

Expected: Native admin JSON for one plan (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on apply in Platform Ads Manager. Path: plans/{planId}/apply.

Expected: Native admin JSON for the created apply (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new google in Platform Ads Manager. Send the native admin JSON body. Path: google/campaigns/from-social-post.

Expected: Native admin JSON for the created from social post (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one campaign (and related fields) from Platform Ads Manager by id. Path: {provider}/campaigns.

Expected: Native admin JSON list or payload for campaign (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on campaign in Platform Ads Manager. Path: {provider}/campaigns.

Expected: Native admin JSON for the created campaign (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one campaign (and related fields) from Platform Ads Manager by id. Path: {provider}/campaigns/{id}.

Expected: Native admin JSON for one campaign (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a campaign in Platform Ads Manager. Send the complete resource payload. Path: {provider}/campaigns/{id}.

Expected: Native admin JSON for the updated campaign. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a nested resource or trigger an action on launch in Platform Ads Manager. Path: {provider}/campaigns/{id}/launch.

Expected: Native admin JSON for the created launch (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on schedule in Platform Ads Manager. Path: {provider}/campaigns/{id}/schedule.

Expected: Native admin JSON for the created schedule (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Cancel this cancel in Platform Ads Manager. Send a JSON body as required by the admin API. Path: {provider}/campaigns/{id}/schedule/cancel.

Expected: Native admin JSON for the created cancel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Check status of this statu in Platform Ads Manager. Send a JSON body as required by the admin API. Path: {provider}/campaigns/{id}/status.

Expected: Native admin JSON for the created statu (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a budget in Platform Ads Manager. Send the complete resource payload. Path: {provider}/campaigns/{id}/budget.

Expected: Native admin JSON for the updated budget. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a nested resource or trigger an action on link social post in Platform Ads Manager. Path: {provider}/campaigns/{id}/link-social-post.

Expected: Native admin JSON for the created link social post (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Check status of this statu in Platform Ads Manager. Send a JSON body as required by the admin API. Path: {provider}/entities/{type}/{id}/status.

Expected: Native admin JSON for the created statu (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one ads (and related fields) from Platform Ads Manager by id. Path: {provider}/ads.

Expected: Native admin JSON list or payload for ads (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one ads (and related fields) from Platform Ads Manager by id. Path: {provider}/ads/{id}.

Expected: Native admin JSON for one ads (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on creative in Platform Ads Manager. Path: {provider}/creatives.

Expected: Native admin JSON for the created creative (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Sync this sync in Platform Ads Manager. Send a JSON body as required by the admin API. Path: {provider}/sync.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Lightweight health check for AIKit. Verifies the feature is enabled for this White Label and that the token includes aikit:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "aikit"
  }
}

List settings for AIKit, optionally filtered by query params. Path: settings.

Expected: Native admin JSON list or payload for settings (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a settings in AIKit. Send the complete resource payload. Path: settings.

Expected: Native admin JSON for the updated settings. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List agents for AIKit, optionally filtered by query params. Path: agents.

Expected: Native admin JSON list or payload for agents (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one agent (and related fields) from AIKit by id. Path: agents/{id}.

Expected: Native admin JSON for one agent (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new agent in AIKit. Send the native admin JSON body. Path: agents.

Expected: Native admin JSON for the created agents (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a agent in AIKit. Send the complete resource payload. Path: agents/{id}.

Expected: Native admin JSON for the updated agent. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a agent from AIKit. Path: agents/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Test this test in AIKit. Send a JSON body as required by the admin API. Path: agents/{id}/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List providers for AIKit, optionally filtered by query params. Path: providers/openai/models.

Expected: Native admin JSON list or payload for models (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List providers for AIKit, optionally filtered by query params. Path: providers/cursor/models.

Expected: Native admin JSON list or payload for models (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List orchestration for AIKit, optionally filtered by query params. Path: orchestration.

Expected: Native admin JSON list or payload for orchestration (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a orchestration in AIKit. Send the complete resource payload. Path: orchestration.

Expected: Native admin JSON for the updated orchestration. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List chatbot for AIKit, optionally filtered by query params. Path: chatbot.

Expected: Native admin JSON list or payload for chatbot (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a chatbot in AIKit. Send the complete resource payload. Path: chatbot.

Expected: Native admin JSON for the updated chatbot. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Send a chat request to chatbot in AIKit. Send a JSON body as required by the admin API. Path: chatbot/chat.

Expected: Native admin JSON for the created chat (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List public site chatbot for AIKit, optionally filtered by query params. Path: public-site-chatbot.

Expected: Native admin JSON list or payload for public site chatbot (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a public site chatbot in AIKit. Send the complete resource payload. Path: public-site-chatbot.

Expected: Native admin JSON for the updated public site chatbot. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List prompts for AIKit, optionally filtered by query params. Path: prompts.

Expected: Native admin JSON list or payload for prompts (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new prompt in AIKit. Send the native admin JSON body. Path: prompts.

Expected: Native admin JSON for the created prompts (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new prompt in AIKit. Send the native admin JSON body. Path: prompts/seed.

Expected: Native admin JSON for the created seed (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one page (and related fields) from AIKit by id. Path: prompts/page/{slug}.

Expected: Native admin JSON for one page (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a prompt in AIKit. Send the complete resource payload. Path: prompts/{id}.

Expected: Native admin JSON for the updated prompt. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a prompt from AIKit. Path: prompts/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List autowrite for AIKit, optionally filtered by query params. Path: autowrite.

Expected: Native admin JSON list or payload for autowrite (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new autowrite in AIKit. Send the native admin JSON body. Path: autowrite.

Expected: Native admin JSON for the created autowrite (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Run this run in AIKit. Send a JSON body as required by the admin API. Path: autowrite/{id}/run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List autowrite for AIKit, optionally filtered by query params. Path: autowrite/articles.

Expected: Native admin JSON list or payload for articles (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Permanently delete a article from AIKit. Path: autowrite/articles/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on regenerate content in AIKit. Path: autowrite/articles/{id}/regenerate-content.

Expected: Native admin JSON for the created regenerate content (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on regenerate image in AIKit. Path: autowrite/articles/{id}/regenerate-image.

Expected: Native admin JSON for the created regenerate image (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one log (and related fields) from AIKit by id. Path: autowrite/articles/{id}/log.

Expected: Native admin JSON list or payload for log (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a content in AIKit. Send the complete resource payload. Path: autowrite/articles/{id}/content.

Expected: Native admin JSON for the updated content. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Assign this assign in AIKit. Send a JSON body as required by the admin API. Path: autowrite/articles/{id}/assign.

Expected: Native admin JSON for the created assign (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one autowrite (and related fields) from AIKit by id. Path: autowrite/{id}.

Expected: Native admin JSON for one autowrite (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a autowrite from AIKit. Path: autowrite/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List repurpose for AIKit, optionally filtered by query params. Path: repurpose.

Expected: Native admin JSON list or payload for repurpose (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new repurpose in AIKit. Send the native admin JSON body. Path: repurpose.

Expected: Native admin JSON for the created repurpose (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a repurpose from AIKit. Path: repurpose/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one repurpose (and related fields) from AIKit by id. Path: repurpose/{id}.

Expected: Native admin JSON for one repurpose (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on post to n8n in AIKit. Path: repurpose/{id}/post-to-n8n.

Expected: Native admin JSON for the created post to n8n (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Pause this pause in AIKit. Send a JSON body as required by the admin API. Path: repurpose/{id}/pause.

Expected: Native admin JSON for the created pause (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List rss for AIKit, optionally filtered by query params. Path: rss.

Expected: Native admin JSON list or payload for rss (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new rs in AIKit. Send the native admin JSON body. Path: rss.

Expected: Native admin JSON for the created rss (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new rs in AIKit. Send the native admin JSON body. Path: rss/test-rapidapi.

Expected: Native admin JSON for the created test rapidapi (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a rss in AIKit. Send the complete resource payload. Path: rss/{id}.

Expected: Native admin JSON for the updated rss. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a rss from AIKit. Path: rss/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Run this run in AIKit. Send a JSON body as required by the admin API. Path: rss/{id}/run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List rss for AIKit, optionally filtered by query params. Path: rss/subscribers.

Expected: Native admin JSON list or payload for subscribers (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List rss for AIKit, optionally filtered by query params. Path: rss/campaigns.

Expected: Native admin JSON list or payload for campaigns (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new rs in AIKit. Send the native admin JSON body. Path: rss/campaign/send.

Expected: Native admin JSON for the created send (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List rss for AIKit, optionally filtered by query params. Path: rss/generated-content.

Expected: Native admin JSON list or payload for generated content (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Partially update a statu in AIKit. Send only the fields to change. Path: rss/generated-content/{id}/status.

Expected: Native admin JSON for the updated statu. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a generated content in AIKit. Send the complete resource payload. Path: rss/generated-content/{id}.

Expected: Native admin JSON for the updated generated content. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a generated content from AIKit. Path: rss/generated-content/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List rss for AIKit, optionally filtered by query params. Path: rss/stats.

Expected: Native admin JSON list or payload for stats (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one rss (and related fields) from AIKit by id. Path: rss/{id}.

Expected: Native admin JSON for one rss (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List scheduled for AIKit, optionally filtered by query params. Path: scheduled.

Expected: Native admin JSON list or payload for scheduled (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new scheduled in AIKit. Send the native admin JSON body. Path: scheduled.

Expected: Native admin JSON for the created scheduled (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a scheduled in AIKit. Send the complete resource payload. Path: scheduled/{id}.

Expected: Native admin JSON for the updated scheduled. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a scheduled from AIKit. Path: scheduled/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Retrieve one digest log (and related fields) from AIKit by id. Path: scheduled/{id}/digest-log.

Expected: Native admin JSON list or payload for digest log (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List scheduled for AIKit, optionally filtered by query params. Path: scheduled/all.

Expected: Native admin JSON list or payload for all (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new scheduled in AIKit. Send the native admin JSON body. Path: scheduled/all.

Expected: Native admin JSON for the created all (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a all in AIKit. Send the complete resource payload. Path: scheduled/all/{id}.

Expected: Native admin JSON for the updated all. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a new scheduled in AIKit. Send the native admin JSON body. Path: scheduled/action/run-now.

Expected: Native admin JSON for the created run now (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new scheduled in AIKit. Send the native admin JSON body. Path: scheduled/action/toggle.

Expected: Native admin JSON for the created toggle (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new scheduled in AIKit. Send the native admin JSON body. Path: scheduled/action/delete.

Expected: Native admin JSON for the created delete (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List finetune for AIKit, optionally filtered by query params. Path: finetune.

Expected: Native admin JSON list or payload for finetune (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new finetune in AIKit. Send the native admin JSON body. Path: finetune.

Expected: Native admin JSON for the created finetune (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on start in AIKit. Path: finetune/{id}/start.

Expected: Native admin JSON for the created start (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Sync this sync in AIKit. Send a JSON body as required by the admin API. Path: finetune/{id}/sync.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Cancel this cancel in AIKit. Send a JSON body as required by the admin API. Path: finetune/{id}/cancel.

Expected: Native admin JSON for the created cancel (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one log (and related fields) from AIKit by id. Path: finetune/{id}/log.

Expected: Native admin JSON list or payload for log (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a nested resource or trigger an action on register in AIKit. Path: finetune/{id}/register.

Expected: Native admin JSON for the created register (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List finetune for AIKit, optionally filtered by query params. Path: finetune/models.

Expected: Native admin JSON list or payload for models (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List finetune for AIKit, optionally filtered by query params. Path: finetune/chat/conversations.

Expected: Native admin JSON list or payload for conversations (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new finetune in AIKit. Send the native admin JSON body. Path: finetune/chat/conversations.

Expected: Native admin JSON for the created conversations (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one message (and related fields) from AIKit by id. Path: finetune/chat/conversations/{id}/messages.

Expected: Native admin JSON list or payload for message (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new finetune in AIKit. Send the native admin JSON body. Path: finetune/chat/send.

Expected: Native admin JSON for the created send (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List finetune for AIKit, optionally filtered by query params. Path: finetune/verify.

Expected: Native admin JSON list or payload for verify (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Permanently delete a finetune from AIKit. Path: finetune/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Export AIKit (export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Import AIKit. Send a JSON body as required by the admin API. Path: import.

Expected: Native admin JSON for the created import (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in AIKit. Send the native admin JSON body. Path: import/preview.

Expected: Native admin JSON for the created preview (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new import in AIKit. Send the native admin JSON body. Path: import/apply.

Expected: Native admin JSON for the created apply (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List decision for AIKit, optionally filtered by query params. Path: decision.

Expected: Native admin JSON list or payload for decision (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List decision for AIKit, optionally filtered by query params. Path: decision/catalog.

Expected: Native admin JSON list or payload for catalog (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List decision for AIKit, optionally filtered by query params. Path: decision/dashboard-snapshot.

Expected: Native admin JSON list or payload for dashboard snapshot (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one log (and related fields) from AIKit by id. Path: decision/logs/{id}.

Expected: Native admin JSON for one log (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List decision for AIKit, optionally filtered by query params. Path: decision/logs.

Expected: Native admin JSON list or payload for logs (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one decision (and related fields) from AIKit by id. Path: decision/{id}.

Expected: Native admin JSON for one decision (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new decision in AIKit. Send the native admin JSON body. Path: decision.

Expected: Native admin JSON for the created decision (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a decision in AIKit. Send the complete resource payload. Path: decision/{id}.

Expected: Native admin JSON for the updated decision. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a decision from AIKit. Path: decision/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a nested resource or trigger an action on execute in AIKit. Path: decision/{id}/execute.

Expected: Native admin JSON for the created execute (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List cs ticket ai for AIKit, optionally filtered by query params. Path: cs-ticket-ai/config.

Expected: Native admin JSON list or payload for config (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a config in AIKit. Send the complete resource payload. Path: cs-ticket-ai/config.

Expected: Native admin JSON for the updated config. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

List cs ticket ai for AIKit, optionally filtered by query params. Path: cs-ticket-ai/runs.

Expected: Native admin JSON list or payload for runs (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one run (and related fields) from AIKit by id. Path: cs-ticket-ai/runs/{id}.

Expected: Native admin JSON for one run (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List content builder for AIKit, optionally filtered by query params. Path: content-builder/runs.

Expected: Native admin JSON list or payload for runs (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one run (and related fields) from AIKit by id. Path: content-builder/runs/{id}.

Expected: Native admin JSON for one run (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Run content builder in AIKit. Send a JSON body as required by the admin API. Path: content-builder/run.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Create a new form fill in AIKit. Send the native admin JSON body. Path: form-fill.

Expected: Native admin JSON for the created form fill (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new page chat in AIKit. Send the native admin JSON body. Path: page-chat.

Expected: Native admin JSON for the created page chat (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List chat for AIKit, optionally filtered by query params. Path: chat/conversations.

Expected: Native admin JSON list or payload for conversations (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new chat in AIKit. Send the native admin JSON body. Path: chat/conversations.

Expected: Native admin JSON for the created conversations (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one message (and related fields) from AIKit by id. Path: chat/conversations/{id}/messages.

Expected: Native admin JSON list or payload for message (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Partially update a conversation in AIKit. Send only the fields to change. Path: chat/conversations/{id}.

Expected: Native admin JSON for the updated conversation. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a conversation in AIKit. Send the complete resource payload. Path: chat/conversations/{id}.

Expected: Native admin JSON for the updated conversation. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a conversation from AIKit. Path: chat/conversations/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a new chat in AIKit. Send the native admin JSON body. Path: chat/send.

Expected: Native admin JSON for the created send (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List usage for AIKit, optionally filtered by query params. Path: usage/stats.

Expected: Native admin JSON list or payload for stats (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fetch analytics for dashboard in AIKit (dashboard/analytics).

Expected: Native admin JSON list or payload for analytics (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Lightweight health check for Accounting. Verifies the feature is enabled for this White Label and that the token includes accounting:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "accounting"
  }
}

List config for Accounting, optionally filtered by query params. Path: config.

Expected: Native admin JSON list or payload for config (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a config in Accounting. Send the complete resource payload. Path: config.

Expected: Native admin JSON for the updated config. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Test config in Accounting. Send a JSON body as required by the admin API. Path: config/message-broker/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Test config in Accounting. Send a JSON body as required by the admin API. Path: config/open-banking/test.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

List settings for Accounting, optionally filtered by query params. Path: settings.

Expected: Native admin JSON list or payload for settings (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List fx rates for Accounting, optionally filtered by query params. Path: fx-rates.

Expected: Native admin JSON list or payload for fx rates (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List fx rates for Accounting, optionally filtered by query params. Path: fx-rates/latest.

Expected: Native admin JSON list or payload for latest (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new fx rate in Accounting. Send the native admin JSON body. Path: fx-rates.

Expected: Native admin JSON for the created fx rates (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Sync income in Accounting. Send a JSON body as required by the admin API. Path: income/sync.

Expected: Native admin JSON acknowledging the job/action (often includes id/status). May be async — poll a status/report endpoint afterward.

{
  "success": true,
  "data": {
    "id": "…",
    "status": "running"
  }
}

Create a new income in Accounting. Send the native admin JSON body. Path: income.

Expected: Native admin JSON for the created income (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Permanently delete a income from Accounting. Path: income/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List income for Accounting, optionally filtered by query params. Path: income.

Expected: Native admin JSON list or payload for income (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new invoice in Accounting. Send the native admin JSON body. Path: invoices.

Expected: Native admin JSON for the created invoices (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List invoices for Accounting, optionally filtered by query params. Path: invoices.

Expected: Native admin JSON list or payload for invoices (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one invoice (and related fields) from Accounting by id. Path: invoices/{id}.

Expected: Native admin JSON for one invoice (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Download a specific download in Accounting (invoices/{id}/download).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Permanently delete a invoice from Accounting. Path: invoices/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Fully update / replace a statu in Accounting. Send the complete resource payload. Path: invoices/{id}/status.

Expected: Native admin JSON for the updated statu. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Create a new expense in Accounting. Send the native admin JSON body. Path: expenses.

Expected: Native admin JSON for the created expenses (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a receipt in Accounting. Send the complete resource payload. Path: expenses/{id}/receipt.

Expected: Native admin JSON for the updated receipt. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a expense from Accounting. Path: expenses/{id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

List expenses for Accounting, optionally filtered by query params. Path: expenses.

Expected: Native admin JSON list or payload for expenses (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List summaries for Accounting, optionally filtered by query params. Path: summaries.

Expected: Native admin JSON list or payload for summaries (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one summarie (and related fields) from Accounting by id. Path: summaries/{year}/{month}.

Expected: Native admin JSON for one summarie (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a nested resource or trigger an action on recalculate in Accounting. Path: summaries/{year}/{month}/recalculate.

Expected: Native admin JSON for the created recalculate (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a close in Accounting. Send the complete resource payload. Path: summaries/{year}/{month}/close.

Expected: Native admin JSON for the updated close. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a request in Accounting. Send the complete resource payload. Path: summaries/{year}/{month}/close/request.

Expected: Native admin JSON for the updated request. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a approve in Accounting. Send the complete resource payload. Path: summaries/{year}/{month}/close/approve.

Expected: Native admin JSON for the updated approve. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a reopen in Accounting. Send the complete resource payload. Path: summaries/{year}/{month}/reopen.

Expected: Native admin JSON for the updated reopen. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Retrieve one mom (and related fields) from Accounting by id. Path: comparative/mom/{year}/{month}.

Expected: Native admin JSON for one mom (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one yoy (and related fields) from Accounting by id. Path: comparative/yoy/{year}/{month}.

Expected: Native admin JSON for one yoy (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List reconciliation for Accounting, optionally filtered by query params. Path: reconciliation.

Expected: Native admin JSON list or payload for reconciliation (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Create a new reconciliation in Accounting. Send the native admin JSON body. Path: reconciliation.

Expected: Native admin JSON for the created reconciliation (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new reconciliation in Accounting. Send the native admin JSON body. Path: reconciliation/sync-gateways.

Expected: Native admin JSON for the created sync gateways (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new reconciliation in Accounting. Send the native admin JSON body. Path: reconciliation/sync-open-banking.

Expected: Native admin JSON for the created sync open banking (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one suggest (and related fields) from Accounting by id. Path: reconciliation/{id}/suggest.

Expected: Native admin JSON list or payload for suggest (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Fully update / replace a match in Accounting. Send the complete resource payload. Path: reconciliation/{id}/match.

Expected: Native admin JSON for the updated match. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Fully update / replace a ignore in Accounting. Send the complete resource payload. Path: reconciliation/{id}/ignore.

Expected: Native admin JSON for the updated ignore. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a data from Accounting. Path: data.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}

Create a new data in Accounting. Send the native admin JSON body. Path: data/seed.

Expected: Native admin JSON for the created seed (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Create a new report in Accounting. Send the native admin JSON body. Path: reports.

Expected: Native admin JSON for the created reports (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one monthly (and related fields) from Accounting by id. Path: reviews/monthly/{year}/{month}.

Expected: Native admin JSON for one monthly (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one quarterly (and related fields) from Accounting by id. Path: reviews/quarterly/{year}/{quarter}.

Expected: Native admin JSON for one quarterly (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one yearly (and related fields) from Accounting by id. Path: reviews/yearly/{year}.

Expected: Native admin JSON for one yearly (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List reviews for Accounting, optionally filtered by query params. Path: reviews/full.

Expected: Native admin JSON list or payload for full (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Export reviews in Accounting (reviews/export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

List reports for Accounting, optionally filtered by query params. Path: reports.

Expected: Native admin JSON list or payload for reports (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Retrieve one recommendation (and related fields) from Accounting by id. Path: recommendations/{year}/{month}.

Expected: Native admin JSON for one recommendation (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List recommendations for Accounting, optionally filtered by query params. Path: recommendations.

Expected: Native admin JSON list or payload for recommendations (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List or fetch the root Accounting collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Lightweight health check for Password Keeper. Verifies the feature is enabled for this White Label and that the token includes password-keeper:health.

Expected: JSON: { success: true, data: { status: "ok", featureId, whiteLabelId, scopes } }

{
  "success": true,
  "data": {
    "status": "ok",
    "featureId": "password-keeper"
  }
}

Create a new item in Password Keeper. Send the native admin JSON body. Path: (root).

Expected: Native admin JSON for the created resource (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

List or fetch the root Password Keeper collection.

Expected: Native admin JSON list or payload for resource (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

List categories for Password Keeper, optionally filtered by query params. Path: categories.

Expected: Native admin JSON list or payload for categories (often { success, data: […] } or { items/rows }). Empty arrays when none exist.

{
  "success": true,
  "data": []
}

Export Password Keeper (export).

Expected: File download or binary/JSON export payload (Content-Type depends on the export format).

{
  "download": true
}

Import Password Keeper. Send a JSON body as required by the admin API. Path: import.

Expected: Native admin JSON for the created import (often { success, data } with the new id). 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Retrieve one item (and related fields) from Password Keeper by id. Path: {id}.

Expected: Native admin JSON for one item (often { success, data } or the document itself). 404 if not found / not in your tenant.

{
  "success": true,
  "data": {
    "id": "…"
  }
}

Fully update / replace a item in Password Keeper. Send the complete resource payload. Path: {id}.

Expected: Native admin JSON for the updated item. 404 if missing; 4xx on validation errors.

{
  "success": true,
  "data": {
    "id": "…",
    "updated": true
  }
}

Permanently delete a item from Password Keeper. Path: {id}.

Expected: Native admin JSON confirming deletion (often { success: true } or { deleted: true }). 404 if already gone.

{
  "success": true,
  "deleted": true
}