### GET /api/setup

Source: https://voxcloud.nl/docs/intravox/architecture/overview/

Checks the setup status.

```APIDOC
## GET /api/setup

### Description
Checks the setup status.

### Method
GET

### Endpoint
/api/setup

### Response
#### Success Response (200)
- Setup status information

#### Response Example
```json
{
  "status": "completed"
}
```
```

--------------------------------

### List forms (cURL)

Source: https://voxcloud.nl/docs/formvox/architecture/api-reference/

Quickstart example to list all forms using the internal API. Requires a valid Nextcloud app password.

```bash
curl -u "username:app-password" \
  https://your-nextcloud.com/apps/formvox/api/forms
```

--------------------------------

### Fetch responses for a form (cURL)

Source: https://voxcloud.nl/docs/formvox/architecture/api-reference/

Quickstart example to retrieve responses for a specific form, identified by its fileId. Replace {fileId} with the actual form file ID.

```bash
curl -u "username:app-password" \
  "https://your-nextcloud.com/apps/formvox/api/forms/{fileId}/responses"
```

--------------------------------

### Install standard templates with occ intravox:setup

Source: https://voxcloud.nl/docs/intravox/user/templates/

Command to install standard templates. It creates `_templates` folders per language, copies the 7 standard templates, and copies template images to the `_media` folder of each template. Existing templates are skipped; to reinstall, delete the template folder and run the command again.

```bash
sudo -u www-data php occ intravox:setup
```

--------------------------------

### Request examples for createPageFromTemplate

Source: https://voxcloud.nl/docs/intravox/architecture/api-development/

Multiple examples showing different templates and optional parameters. Demonstrates using parentPath or omitting it.

```json
"examples": {
  "department": {
    "summary": "HR-afdeling-pagina maken",
    "value": {
      "templateId": "department",
      "pageTitle": "HR-afdeling",
      "parentPath": "/teams"
    }
  },
  "event": {
    "summary": "Bedrijfs-event-pagina maken",
    "value": {
      "templateId": "event",
      "pageTitle": "Jaarcongres 2026"
    }
  }
}
```

--------------------------------

### Export responses as CSV (cURL)

Source: https://voxcloud.nl/docs/formvox/architecture/api-reference/

Quickstart example to export responses in CSV format. The -o flag saves the output to responses.csv. Replace {fileId} with the form's file ID.

```bash
curl -u "username:app-password" \
  -o responses.csv \
  "https://your-nextcloud.com/apps/formvox/api/forms/{fileId}/export?format=csv"
```

--------------------------------

### Submit a public form (cURL)

Source: https://voxcloud.nl/docs/formvox/architecture/api-reference/

Quickstart example to submit a public form using a POST request with JSON payload. Replace {publicHash} with the form's public hash.

```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"answers": {"q1": "Jan Jansen", "q2": "5"}}' \
  https://your-nextcloud.com/apps/formvox/public/submit/{publicHash}
```

--------------------------------

### Run Nextcloud setup checks

Source: https://voxcloud.nl/docs/metavox/admin/installation/

Run the setup checks from the command line to see MetaVox's checks.

```bash
sudo -u www-data php occ setupchecks
```

--------------------------------

### Install Generated JavaScript Client

Source: https://voxcloud.nl/docs/intravox/architecture/openapi-tooling/

Install the generated JavaScript client locally and link it globally.

```bash
cd intravox-client-js
npm install
npm link  # Globaal beschikbaar maken
```

--------------------------------

### Install Generated Python Client

Source: https://voxcloud.nl/docs/intravox/architecture/openapi-tooling/

Install the generated Python client in editable mode.

```bash
cd intravox-client-py
pip install -e .
```

--------------------------------

### Set up Client Push

Source: https://voxcloud.nl/docs/metavox/admin/installation/

Run the setup command for the Client Push (notify_push) app to enable live updates.

```bash
occ notify_push:setup
```

--------------------------------

### Authorization header example

Source: https://voxcloud.nl/docs/roomvox/admin/troubleshooting/

Example of the Authorization header required for API requests. The header is case-insensitive and tokens start with 'rvx_'.

```http
Authorization: Bearer rvx_your_token_here
```

--------------------------------

### POST /api/setup

Source: https://voxcloud.nl/docs/en/intravox/route-table/

Runs the setup process. Admin access is checked in the request body. CSRF protection is required.

```APIDOC
## POST /api/setup

### Description
Runs the setup process.

### Method
POST

### Endpoint
/api/setup

### Access
Admin (checked in body)

### CSRF
Required
```

--------------------------------

### Herstart IntroVox-tour via browserconsole (window.introVox.start())

Source: https://voxcloud.nl/docs/introvox/user/personal-settings/

Gebruik deze JavaScript-opdracht in de browserconsole (F12) om de welkomsttour handmatig te starten. Werkt alleen wanneer je bent ingelogd en op een Nextcloud-pagina staat.

```javascript
window.introVox.start()
```

--------------------------------

### Export structure v1.1 with MetaVox

Source: https://voxcloud.nl/docs/intravox/admin/export-import/

JSON example of the export structure for format v1.1 when MetaVox is installed, including exportVersion, language, metavox metadata, navigation, footer, and pages.

```json
{
  "exportVersion": "1.1",
  "exportDate": "2025-12-16T14:30:00+00:00",
  "language": "nl",
  "metavox": {
    "version": "1.3.0",
    "fieldDefinitions": [
      {
        "field_name": "document_type",
        "field_label": "Document Type",
        "field_type": "select",
        "field_description": "Type of document",
        "field_options": ["Policy", "Procedure", "Guide"],
        "is_required": true,
        "sort_order": 0,
        "scope": "groupfolder"
      }
    ]
  },
  "navigation": {...},
  "footer": {...},
  "pages": [...]
}
```

--------------------------------

### Install IntroVox from source

Source: https://voxcloud.nl/docs/introvox/deployment/installation/

Clones the IntroVox repository, installs dependencies, builds the frontend, and enables the app. Requires node and npm on the server.

```bash
git clone https://github.com/nextcloud/IntroVox.git /var/www/nextcloud/apps/introvox
cd /var/www/nextcloud/apps/introvox
npm install
npm run build
sudo -u www-data php occ app:enable introvox
```

--------------------------------

### List templates response (200 OK)

Source: https://voxcloud.nl/docs/intravox/architecture/template-api-quickstart/

Example JSON response from the GET /api/templates endpoint. Shows metadata for the built-in 'department' and 'event' templates, including id, name, description, columnCount, widgetCount, widgetTypes, complexity, hasHeaderRow, and hasSidebars.

```json
{
  "templates": [
    {
      "id": "department",
      "name": "Department",
      "description": "Team-informatie, services en resources",
      "columnCount": 3,
      "widgetCount": 12,
      "widgetTypes": ["heading", "text", "image", "links"],
      "complexity": "medium",
      "hasHeaderRow": true,
      "hasSidebars": false
    },
    {
      "id": "event",
      "name": "Event",
      "description": "Event-planning, sprekers en registratie",
      "columnCount": 3,
      "widgetCount": 15,
      "widgetTypes": ["heading", "text", "image", "video", "links"],
      "complexity": "advanced",
      "hasHeaderRow": true,
      "hasSidebars": true
    }
  ]
}
```

--------------------------------

### Install and configure notify_push for real-time sync

Source: https://voxcloud.nl/docs/metavox/features/real-time-sync/

Complete installation and configuration of Nextcloud's notify_push app, including copying the binary, creating a systemd service, setting up an Apache reverse proxy, and configuring trusted proxies and base endpoint. Run these commands as root or with sudo. After installation, verify with the self-test command; all checks should show ✓.

```bash
# notify_push installeren
sudo -u www-data php /var/www/nextcloud/occ app:install notify_push

# Binary kopiëren
sudo cp /var/www/nextcloud/apps/notify_push/bin/x86_64/notify_push /usr/local/bin/notify_push
sudo chmod +x /usr/local/bin/notify_push

# systemd-service aanmaken
sudo tee /etc/systemd/system/notify_push.service << 'EOF'
[Unit]
Description=Nextcloud Push Notification Service
After=network.target

[Service]
Type=simple
User=www-data
ExecStart=/usr/local/bin/notify_push /var/www/nextcloud/config/config.php
Restart=always
RestartSec=5
Environment=PORT=7867

[Install]
WantedBy=multi-user.target
EOF

sudo systemctl daemon-reload
sudo systemctl enable --now notify_push

# Apache reverse proxy
sudo tee /etc/apache2/conf-available/notify_push.conf << 'EOF'
ProxyPass /push/ws ws://127.0.0.1:7867/ws
ProxyPass /push/ http://127.0.0.1:7867/
ProxyPassReverse /push/ http://127.0.0.1:7867/
EOF

sudo a2enmod proxy proxy_http proxy_wstunnel
sudo a2enconf notify_push
sudo systemctl restart apache2

# Configureren
sudo -u www-data php /var/www/nextcloud/occ config:system:set trusted_proxies 0 --value='127.0.0.1'
sudo -u www-data php /var/www/nextcloud/occ config:app:set notify_push base_endpoint --value='https://your-domain.com/push'

# Verifiëren
sudo -u www-data php /var/www/nextcloud/occ notify_push:self-test
```

--------------------------------

### Verify OpenAPI Generator CLI Installation

Source: https://voxcloud.nl/docs/intravox/architecture/openapi-tooling/

Check the installed version of the OpenAPI Generator CLI.

```bash
openapi-generator-cli version
```

--------------------------------

### Command-line demo data installation

Source: https://voxcloud.nl/docs/intravox/admin/guide/

Installs demo data for the Dutch language via the occ command. Must be run as the web server user (www-data). The language must match the user's Nextcloud language setting to see the demo content.

```bash
sudo -u www-data php occ intravox:import-demo-data --language=nl
```