The SnagBane REST API: read forms and responses, subscribe to events

A REST API with personal tokens to list forms, read questions and responses, download response PDFs and subscribe REST hooks — 120 requests per minute, with examples in curl, PowerShell and Python.

SnagBane has a REST API for your own scripts and systems. Create a personal API token, then list forms, read their questions and responses, download a response as PDF and subscribe REST hooks for new responses. The REST API is part of the Business plan.

Basics

  • Base URL: https://your-domain/api/v1
  • Header: Authorization: Bearer sb_…
  • Limit: 120 requests per minute
  • A token acts as the person who created it — it sees exactly what they may see.

Create tokens under Automations & API → Personal API tokens. Administrators can list everyone's tokens with their owners and revoke forgotten ones; this is recorded in the audit log.

Endpoints

Method & pathWhat it does
GET /meThe token's user
GET /formsList forms
GET /forms/{id}A form with its questions (key, label, type, options)
GET /forms/{id}/responses?since=&top=&page=Responses, newest first, paginated
GET /forms/{id}/responses/{responseId}One response
GET /forms/{id}/responses/{responseId}/pdfThe response as a PDF
POST /hooksSubscribe a REST hook (returns its id and signing secret)
DELETE /hooks/{id}Unsubscribe
GET /hooks/sample/{form}A sample payload for mapping fields
curl https://forms.example.com/api/v1/forms/2/responses?top=10 \
  -H "Authorization: Bearer sb_xxx"

Behind a firewall

SnagBane runs on your own server, so the API can stay inside your network. The documentation describes how to expose only what an external service (such as Power Automate) needs.

Frequently asked questions

Is there an API reference?

Yes — the REST API reference has every endpoint with examples in curl, PowerShell and Python, errors, pagination, answer formats and webhook verification.

Can the API create responses?

The API is for reading forms and responses and subscribing to events. Responses are sent through the forms themselves.

See REST API in the documentation.

Try it on your own server

Free for teams up to 25 people. Install with Docker, on a VPS or on cPanel hosting.