External API

The External API provides programmatic access to your data via a RESTful interface. API keys grant scoped, per-table permissions with configurable rate limiting.

Getting Access

API keys are managed by Super Admins. To get a key:

  1. Contact a Super Admin on your team and request an API key.
  2. The admin will generate a key in Admin > API Keys and configure its permissions (which tables and actions it can access).
  3. The full key is shown only once at creation. The admin will share it with you securely.
  4. Store the key somewhere safe. If it's lost, a new one must be generated.
The full API key is shown only once at creation. There is no way to retrieve it later.

Authentication

All requests require a Bearer token in the Authorization header:

Authorization: Bearer lbkey_GENERATED_KEY

Keys are prefixed with lbkey_ followed by a unique generated string. Include the full key including the prefix.

Base URL

https://www.linkbase.house/api/v1/data

All API requests use this single endpoint. The table parameter determines which data you're accessing.

Next Steps

  • Endpoints - See all available GET and POST operations with examples.
  • Errors & Limits - Error codes, rate limiting, and restricted tables.
  • API Tester - Interactive tool to test API calls from the browser.
  • Data Schemas - Field reference for each table.