Getting Started with LimeSurvey API

A quick guide to the LimeSurvey API, covering the authentication mechanisms and some basic requests.

Francesco Pastore
9 min readJun 10, 2024

LimeSurvey is one of the most popular survey services available, allowing you to easily create and distribute surveys of any size to your users.

A simple way to integrate LimeSurvey into your project is to use its API. However, the limited documentation available can make the initial setup challenging.

In this article we will explore how to get started with the LimeSurvey API, focusing on authentication mechanisms and basic requests.

From the official website of LimeSurvey


  1. Configuration 🔨
  2. Request and response format ✉️
  3. Authentication 🔑
  4. Examples ✏️
  5. Additional documentation 🔗

1. Configuration 🔨

Local run

Before we can start working with the API, we need to get LimeSurvey up and running, at least locally.

It is possible to run LimeSurvey through Docker using the container built by martialblog on Docker Hub. Be careful that LimeSurvey also needs a SQL database to work with.



Francesco Pastore

An engineering student in Milan and a web developer for an IT company. Write about programming and cybersecurity topics.