Developer Guide

API Access

Get programmatic access to StackBloom products. Generate API keys, make requests, and integrate with your applications.

Available APIs

The following StackBloom products offer REST API access:

📋

Forms Builder

Create forms, submit data programmatically, retrieve submissions

Available on Pro & Business tiers
🔗

URL Shortener

Create short links, retrieve analytics, manage domains

Available on all tiers
📊

Monitor

Create monitors, retrieve uptime data, manage incidents

Available on Pro & Enterprise tiers
âš¡

Automations

Trigger workflows, create integrations, retrieve execution logs

Available on Business & Enterprise tiers
📅

Scheduling

Create bookings, manage availability, sync calendars

Available on Business tier

Note: Other products are adding API access soon. Check the product documentation or contact support for the latest information.

Generating API Keys

1

Navigate to API Settings

Go to your product dashboard → Settings → API Access

Dashboard → [Product] → Settings → API
2

Create New API Key

Click "Create API Key" button and provide:

  • Key name (e.g., "Production Server", "Mobile App")
  • Permissions (read-only or read-write)
  • Optional expiration date
3

Save Your Key

Copy and save your API key immediately. For security reasons, you won't be able to see it again.

Never share your API key publicly or commit it to version control

Making API Requests

Base URL

https://stackbloom.io/api/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Example Request (cURL)

curl -X GET https://stackbloom.io/api/v1/forms \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"

Example Request (JavaScript)

const response = await fetch('https://stackbloom.io/api/v1/forms', { method: 'GET', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } }); const data = await response.json(); console.log(data);

Example Response

{ "success": true, "data": [ { "id": "form_abc123", "name": "Contact Form", "submissions": 42, "created_at": "2025-01-15T10:30:00Z" } ], "pagination": { "page": 1, "limit": 10, "total": 1 } }

Rate Limits

API requests are rate-limited based on your product tier:

Starter/Basic
100

requests per hour

Pro/Advanced
1,000

requests per hour

Business/Enterprise
10,000

requests per hour

Rate Limit Headers

Every API response includes rate limit information in headers:

X-RateLimit-Limit:1000
X-RateLimit-Remaining:995
X-RateLimit-Reset:1640000000

Need higher limits? Contact us at api@stackbloom.io to discuss custom rate limits for your use case.

Common Use Cases

Form Submission Webhooks

Receive form submissions in real-time via webhooks, then process them in your application using the API to add metadata or trigger workflows.

Automated Link Shortening

Generate short links programmatically for your marketing campaigns, then retrieve analytics data via the API.

Custom Monitoring Dashboards

Pull uptime data from the Monitor API to display custom metrics in your internal dashboards or send to external analytics tools.

Workflow Automation

Trigger StackBloom workflows from external events, or use API responses to drive actions in other systems.

Troubleshooting

Getting 401 Unauthorized error?

Common causes:

  • API key is incorrect or has been revoked
  • Missing "Bearer" prefix in Authorization header
  • API key has expired (check expiration date in dashboard)
Getting 403 Forbidden error?

This usually means:

  • Your API key doesn't have permission for this action (check read-only vs read-write)
  • Your product tier doesn't include API access
  • You're trying to access another user's resources
Getting 429 Rate Limit error?

You've exceeded your hourly rate limit. Solutions:

  • Wait until the rate limit resets (check X-RateLimit-Reset header)
  • Implement exponential backoff in your application
  • Upgrade to a higher tier for increased limits
  • Contact us for custom rate limits

API Documentation

Forms API

Complete Forms API reference

URL Shortener API

Link management API docs

Monitor API

Uptime monitoring API reference

Need Help?

Contact our API support team