Developers

Build on Scratchboard with code or AI.

Every app you build in Scratchboard gets a REST API, event webhooks and an MCP endpoint automatically. Connect your own systems, scripts and AI assistants without extra setup.

Three ways in

Pick the one that fits: call the API, react to events, or let an AI assistant do the work.

REST API quick start

Base URL https://api.scratchboard.cloud/v1. Send your API key as a Bearer token.

In Scratchboard, an entity is a type of record, like a table: Leads, Invoices, Employees. Each entity you create (yourself or with the AI Builder) is available at /v1/entity/<entity name>, using the entity's API name. The request body is a JSON object of field names and values.

Create a record
curl -X POST https://api.scratchboard.cloud/v1/entity/leads \
  -H "Authorization: Bearer ak_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Corp", "email": "john@acme.com", "status": "new"}'
List and search records
curl "https://api.scratchboard.cloud/v1/entity/leads?pageSize=20&search=acme" \
  -H "Authorization: Bearer ak_..."
Record endpoints
  • GET/entity/:entityName

    List records (page, pageSize up to 100, search, filters)

  • POST/entity/:entityName/query

    List with filters in a JSON body (for large filters)

  • GET/entity/:entityName/:id

    Get one record

  • POST/entity/:entityName

    Create a record

  • PUT/entity/:entityName/:id

    Update a record

  • DELETE/entity/:entityName/:id

    Delete a record (moves it to trash)

  • POST/entity/:entityName/bulk-update

    Update many records at once

Paths are relative to https://api.scratchboard.cloud/v1.

Keys, permissions and limits

What to know before you write your first integration.

API keys

Create keys on the API Keys page in the app's admin area. Keys start with ak_, are shown once, can expire, and can be limited to specific permissions.

Same permissions as the app

A key acts as the user who created it. Role, record scope and field-level permissions (RBAC) apply to every request, and changes are written to the audit log.

Rate limits

Requests per minute depend on your plan: 120 on Starter, 600 on Pro, custom on Enterprise.

Works with

AI clients over MCP, plus data sources you can sync from inside the app.

ClaudeChatGPTClaude CodeAny MCP clientPostgreSQLMySQLSQL ServerGoogle SheetsREST APIsCSV filesInbound webhooksLibromi Team Inbox

Questions

Straight answers for developers.

Which plans include API access?
All paid plans (Starter, Pro and Enterprise) include the REST API, webhooks and MCP. Limits such as requests per minute, webhook endpoints and MCP connections differ by plan; see pricing. Every plan starts with a 7-day free trial.
Do I need to define an API for each app I build?
No. As soon as an entity exists, its records are available through the same /v1/entity endpoints, and its events can be sent to your webhooks.
Can an API key see everything in the workspace?
No. A key acts as the user who created it and is limited by that user's role, record scope and field permissions. You can also limit a key to specific permissions when you create it.
Is there an SDK?
Not yet. Use the REST API from any language, or the MCP server from an AI assistant.

Where to next

Keep exploring, or start building.

Get your API key

Start a 7-day free trial, create an entity, then generate a key from the API Keys page.