Opbox
Sign inBook a demo

API Overview

The Opbox API lets you read and manage everything in your workspace - organisations, workspaces, members, forms, submissions, tables, matters, documents, automations, pipelines, tasks, invoices, files, and more. Resources are scoped to workspaces within organisations. All API access requires authentication via API keys.

Quick Start

1. Create an API Key

Go to Settings -> API Keys and create a new key. Copy it immediately - you won't be able to see it again.

2. Make Your First Request

Include your API key in the Authorization header:

curl -H "Authorization: Bearer sk_your_api_key" \
     https://your-domain.com/api/forms

3. Explore the API

Browse the resource reference below for every endpoint group.

Base URL

All API requests should be made to your Opbox instance:

https://your-domain.com/api

Response Format

All responses are JSON. Successful responses include the requested data. New and migrated endpoints return a standardised error envelope:

// Success
{
  "forms": [...],
  "success": true
}

// Error (new standard)
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED",
  "details": {}
}

Some older endpoints may still use a simpler { "error": "..." } format while migration is in progress.

Resources