GudForm Developer Documentation

Everything you need to integrate with GudForm, build custom workflows, and create integrations for the marketplace.

Getting Started

1. Create an API Key

Navigate to Dashboard → Settings → API Keys and generate a new key. API keys start with ff_ and are used as Bearer tokens in all API requests.

2. Make Your First Request

curl -X GET https://gudform.com/api/v1/forms \
  -H "Authorization: Bearer ff_your_api_key_here" \
  -H "Content-Type: application/json"

3. Explore the API

The GudForm REST API is organized around standard REST conventions. All responses return JSON. We support CRUD operations on forms and collections, plus read access to form responses.

Base URL

All API endpoints use the following base URL:

https://gudform.com/api/v1

Client Libraries

Use our API with any HTTP client. We also provide typed helpers to speed up integration:

npm install @gudform/sdk

import { GudForm } from "@gudform/sdk";

const client = new GudForm({ apiKey: "ff_your_key" });

// List forms
const { forms } = await client.forms.list();

// List forms in a specific collection
const { forms: filtered } = await client.forms.list({
  collectionId: "collection_id",
});

// List collections
const { collections } = await client.collections.list();

// Get responses
const { responses } = await client.forms.responses("form_id", {
  page: 1,
  limit: 50,
});

API Changelog