Stacker

Search Documentation

Search for pages and topics in the documentation

6 min read

API Access

Access your data programmatically with the Stacker REST API.

Getting Started

The Stacker API allows you to read and write data from your apps programmatically. You can use it to build custom integrations, sync data with other systems, or build custom frontends.

Finding the API in your workspace

  1. Open Settings from the top right of the workspace.
  2. Scroll to API keys.
  3. Create a new key and choose which portal (app) it should be tied to—each key is scoped to the portal you select.
  4. For API documentation that matches your app—endpoints, parameters, and examples—stay in workspace Settings and open API Docs.

Workspace settings are also summarized in Settings overview.

Authentication

API Keys

After you create a key under Settings API keys, include it on every request:

Authorization: Bearer your-api-key-here

Keep your API key secret! Don't commit it to version control or expose it in client-side code.

Endpoints

GET/api/v1/{appSlug}/tables/{tableSlug}/records

List all records in a table. Supports filtering, sorting, and pagination.

GET/api/v1/{appSlug}/tables/{tableSlug}/records/{id}

Get a single record by ID.

POST/api/v1/{appSlug}/tables/{tableSlug}/records

Create a new record. Send field values in the request body.

PATCH/api/v1/{appSlug}/tables/{tableSlug}/records/{id}

Update an existing record. Only include fields to change.

DELETE/api/v1/{appSlug}/tables/{tableSlug}/records/{id}

Delete a record by ID.

Example Request

curl -X GET "https://stacker.ai/api/v1/YOUR_APP_SLUG/tables/projects/records" \
  -H "Authorization: Bearer op_live_xxxxx" \
  -H "Content-Type: application/json"
Response
{
  "data": [
    {
      "id": "rec_abc123",
      "name": "Website Redesign",
      "status": "In Progress",
      "client": "rec_xyz789"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "perPage": 20
  }
}