Toggle sidebar

Surveys-endpoints

Met de Surveys-endpoints haal je informatie op over je vragenlijsten - zowel een lijst van alle vragenlijsten in je account, als de structuur van een specifieke vragenlijst inclusief groepen, vragen en opties.

Endpoints

Methode Pad Beschrijving
GET /api/v1/surveys Lijst met alle vragenlijsten van je account
GET /api/v1/surveys/{id} Details van één vragenlijst

Lijst opvragen

GET /api/v1/surveys
Authorization: Bearer <token>
Accept: application/json

Filters

Naam Waarde Voorbeeld
name (deel van) de naam ?filter[name]=feedback
private 0 (openbaar) of 1 (privé) ?filter[private]=1

Includes

Naam Wat krijg je erbij
groups.questions.options Alle groepen, vragen en antwoordopties van elke vragenlijst
invitation De uitnodigingsmail-instellingen (alleen bij privé)

Voorbeeld: ?include=groups.questions.options,invitation

Eén vragenlijst ophalen

GET /api/v1/surveys/123?include=groups.questions.options
Authorization: Bearer <token>
Accept: application/json

Response-velden

Per vragenlijst krijg je:

  • id - uniek ID
  • name - naam van de vragenlijst
  • token - unieke token voor de publieke URL
  • private - true voor privé-vragenlijst, false voor openbaar
  • active - true als de vragenlijst beschikbaar is voor deelnemers
  • locale - taal van de vragenlijst (bijvoorbeeld nl, en)
  • folder_id - ID van de map waarin de vragenlijst staat (of null)
  • design_id - ID van het gekoppelde ontwerp (of null)
  • max_responses - maximum aantal reacties (of null voor onbeperkt)
  • footer - voettekst onder elke pagina (HTML)
  • message - bedankt-bericht na voltooiing (HTML)
  • redirect_url - URL waarnaar deelnemers worden gestuurd na versturen (of null)
  • continue_automatically - gaat automatisch door na een antwoord
  • send_button - tekst op de verstuur-knop
  • signature - true als handtekening verplicht is
  • signature_description - toelichting bij de handtekening
  • analytics_code - eventuele tracking-code
  • groups - array met groepen (alleen als include gevraagd)
  • invitation - uitnodigingsobject (alleen bij privé en als include gevraagd)

Voorbeeld-response

{
  "data": {
    "id": 123,
    "name": "Klanttevredenheid Q2 2026",
    "token": "abc123def456",
    "private": true,
    "active": true,
    "locale": "nl",
    "folder_id": 5,
    "design_id": 2,
    "max_responses": null,
    "send_button": "Versturen",
    "signature": false,
    "groups": [
      {
        "id": 11,
        "name": "Algemeen",
        "questions": [...]
      }
    ]
  }
}

Gebruikssituaties

  • Synchroniseren met een ander systeem: haal periodiek de lijst op om te zien welke vragenlijsten actief zijn.
  • Vraagstructuur exporteren: gebruik ?include=groups.questions.options om de hele opbouw van een vragenlijst in een eigen documentatie of analyse-tool te krijgen.
  • Voorbereiden van rapportages: combineer met de participants-endpoints om vragen aan antwoorden te koppelen.

Veelgestelde vragen

Je krijgt alle vragenlijsten waar je rechten op hebt, ongeacht of ze actief zijn. Gebruik het active-veld om actieve van inactieve te onderscheiden.

Nee. Vragenlijsten maak je via de admin-omgeving. De API is bedoeld voor lezen en het aanmaken van deelnemers.

id is het interne ID (bijvoorbeeld 123) - gebruik je voor API-calls. token is een lange unieke string die in de publieke URL staat (/s/) - handig om de publieke link op te bouwen.
Participants