Getting Started

Welcome to the SoapBox API! This guide will help you get up and running in minutes.

Quick Start

1. Create an Account

First, create a developer account. This gives you access to the developer dashboard where you can create apps, manage API keys, and view analytics.

2. Create an App

In the dashboard, create a new app to get your API credentials:

Client ID - Identifies your application
Client Secret - Keep this secure, never expose in client-side code
API Key - For server-to-server requests

3. Install the SDK

Install our official TypeScript/JavaScript SDK:

npm install @soapbox/sdk

4. Make Your First Request

import { SoapBox } from '@soapbox/sdk';

const soapbox = new SoapBox({
  apiKey: 'your-api-key'
});

// Get a list of churches
const churches = await soapbox.churches.list();
console.log(churches.data);

Base URL

All API requests should be made to:

https://api.soapboxsuperapp.com/api/v1

Authentication

The API supports two authentication methods:

API Keys - Best for server-to-server communication
OAuth 2.0 - Best for user-authorized access

See the Authentication guide for details.

Rate Limits

Rate limits vary by plan:

Plan	Requests/minute	Apps
Free	100	3
Basic	1,000	10
Pro	10,000	Unlimited

Response Format

All responses are JSON with a consistent structure:

// Success response
{
  "data": { ... },
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "hasMore": true
  }
}

// Error response
{
  "error": "NotFound",
  "message": "Resource not found",
  "statusCode": 404
}