API: Application Programming Interface

What is an API

An API (application programming interface) is a set of rules that lets one program request data or actions from another. Instead of a person clicking through screens, your app sends a request and gets a structured answer, usually in JSON.

A web API works over HTTP. The client calls an address (an endpoint) with a method such as GET or POST and a key that proves who it is. The server checks the key and returns the data, or an error code such as 401 when the key is missing or wrong.

How it works in SurveyNinja

• The REST API is available on every plan, including Free, and returns JSON.
• You create a key in the profile menu under API / MCP and send it in the Authorization header of each request. An account can have up to 5 keys.
• With the API you can list surveys, read responses, download them as CSV or Excel, and manage hidden variables and webhooks.
• One request returns up to 100 responses. Use limit and offset to page through the rest.
• The same key connects AI assistants such as Claude or Cursor through MCP.

Setup steps are in the help article API, and every endpoint is listed in the API reference. For AI assistants, see Connecting AI assistants (MCP).

API or webhook

With an API, your system asks for data when it needs it. A webhook works the other way: SurveyNinja sends each completed response to your address as it arrives. Use the API for scheduled syncs and reports, and a webhook when every response has to reach your CRM right away.

Tips

• Keep the key like a password. Requests made with it have the same access as the workspace owner, and it is shown only once.
• To cut off an app that no longer needs access, delete its key. Requests with a deleted key get the 401 code.