Migration from v2

Learn how to safely migrate from API v2 to v3

Migrating from v2 to v3

SurveyNinja API v3 is the current major version. This section helps developers who already use API v2 migrate safely to v3 and understand what has changed.

The full change table and all examples are in the ## Migration from v2 to v3 section of the api_v3.md file.

Key changes

  • New base URL:
    /api/v2/service → /api/v3/service
  • GET /quiz (survey list): v3 adds folders and additional fields in the response.
  • Pagination: switched to standard page / per_page parameters for most endpoints.
  • New endpoints: /user.
  • New export and report endpoints: export answers and reports to CSV/XLSX/PDF/Word, extra report data and public report links.

Practical migration steps

  1. Update the base URL from /api/v2/service to /api/v3/service.
  2. Check which v2 endpoints you use and find their v3 equivalents in the documentation (surveys, answers, reports first).
  3. If you used pagination, switch to page / per_page parameters where required.
  4. Start using new capabilities as needed: promo codes, export, extra report data, integrations.
  5. Keep a link to the archived v2 documentation if you need time for a gradual migration.

The API_V2_ARCHIVE.md file contains a brief v2 summary, and api_v3.md contains the full list of v3 endpoints and a mapping of key scenarios.