embed and-integrate

API Reference

The QuipForm API allows you to programmatically access form data and submissions using standard HTTP requests.

Use the API to build custom workflows, sync data with internal systems, create dashboards, and automate processes around your forms.

All API requests require authentication using an API key.

Base URL

https://api.quipform.com

All API endpoints are accessed through the base URL above.

Authentication

Authenticate requests using a Bearer token.

Example

GET /v1/forms
Authorization: Bearer YOUR_API_KEY

If authentication fails, the API returns an authorization error.

Never expose API keys in client-side code, public repositories, or browser applications.

Request Format

All requests should use JSON.

Example:

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Response Format

Responses are returned as JSON.

Example:

{
  "id": "form_123",
  "title": "Customer Feedback",
  "created_at": "2026-01-01T12:00:00Z"
}

Forms

List Forms

Retrieve forms available within your workspace.

GET /v1/forms

Example response:

{
  "data": [
    {
      "id": "form_123",
      "title": "Customer Feedback"
    }
  ]
}

Retrieve a Form

Retrieve information about a specific form.

GET /v1/forms/{form_id}

Example:

GET /v1/forms/form_123

Submissions

List Submissions

Retrieve submissions for a form.

GET /v1/forms/{form_id}/submissions

Example response:

{
  "data": [
    {
      "submission_id": "sub_123",
      "submitted_at": "2026-01-01T12:00:00Z"
    }
  ]
}

Retrieve a Submission

Retrieve a specific submission.

GET /v1/submissions/{submission_id}

Pagination

Endpoints that return collections may be paginated.

Example:

GET /v1/forms?page=1&limit=50

Pagination helps improve performance when working with large datasets.

Error Responses

Errors are returned using standard HTTP status codes.

400 Bad Request

{
  "error": "Invalid request"
}

401 Unauthorized

{
  "error": "Authentication failed"
}

404 Not Found

{
  "error": "Resource not found"
}

429 Rate Limited

{
  "error": "Too many requests"
}

Rate Limits

To ensure platform stability, API requests may be rate limited.

If a limit is exceeded, the API returns a 429 Too Many Requests response.

Best practices:

  • Cache responses when possible
  • Avoid unnecessary polling
  • Use webhooks for real-time workflows
  • Batch requests when appropriate

Security Best Practices

When using the API:

  • Store keys in environment variables
  • Rotate credentials periodically
  • Limit access to trusted team members
  • Remove unused API keys
  • Never expose secrets publicly

API keys provide access to your workspace data and should be treated like passwords.

Webhooks vs API

Both APIs and webhooks can automate workflows, but they serve different purposes.

| Feature | API | Webhooks | | --------------------------- | --- | -------- | | Retrieve existing data | ✓ | — | | Real-time submission events | — | ✓ | | Scheduled data syncs | ✓ | — | | Custom dashboards | ✓ | — | | Instant notifications | — | ✓ |

For real-time submission notifications, consider using webhooks.

Troubleshooting

Authentication Failed

Verify:

  • The API key is valid
  • The Authorization header is included
  • The Bearer token format is correct

Empty Responses

Check:

  • The resource exists
  • Your API key has access to the workspace
  • The request parameters are correct

Rate Limit Errors

Reduce request frequency and consider using webhooks for event-driven workflows.

  • Webhooks
  • Webhook Payloads
  • Analytics
  • Developer Settings

The QuipForm API makes it easy to integrate your forms and submission data into custom applications, workflows, and internal tools.