Developer Platform

FabHub developer docs are the canonical public entry point for the API, SDK, MCP tools, webhooks, authentication, and contract reference material. Everything here describes the public surface served from https://api.fabhub.app/v1.

What is available

Public REST API at https://api.fabhub.app/v1, described by OpenAPI.
Official TypeScript SDK (@fabhub/sdk) for typed server-side integrations.
Curated MCP server (@fabhub/mcp) whose tools map one-to-one to public API scopes.
Signed outbound webhooks with a generated AsyncAPI event contract.
API keys for tenant-owned automation and OAuth for approved partner applications.

Conventions

Base URL: https://api.fabhub.app/v1. Every path in this reference is relative to it.
Format: request and response bodies are JSON; request bodies use camelCase keys.
Query parameters use snake_case (for example page_size, contact_types).
IDs are UUID strings. Timestamps are ISO 8601 in UTC (for example 2026-06-20T09:30:00Z).
Authentication: send an API key in the X-API-Key header (or Authorization: Bearer). See Authentication.
Money fields (salePrice, purchasePrice) are numbers in the tenant's base currency, or null.

Core concepts

Tenant: every credential belongs to one tenant (organization); all data is tenant-scoped.
Scopes: keys carry least-privilege scopes such as items:read or webhooks:write.
Idempotency: write requests take an Idempotency-Key so retries are safe. See Idempotency.
Pagination: lists are page-based; audit export is cursor-based. See Pagination.
Errors: a stable JSON envelope with a machine-readable code. See Errors.

Current contract snapshot

OpenAPI version: 1.0.0
Public operations: 47
Public scopes: 15
Webhook channels: 14
MCP tools: 45

Start here

Downloadable contracts

Public-safe source documents

The portal is generated from public-safe developer-platform sources registered in docs/developer-platform/docs-source-registry.json:

docs/developer-platform/api-changelog.md
docs/developer-platform/enterprise-controls.md
docs/developer-platform/hosted-mcp.md
docs/developer-platform/openapi-breaking-change-policy.md
docs/developer-platform/scope-taxonomy.md
docs/developer-platform/usage-endpoint.md
docs/developer-platform/webhook-events.md
docs/developer-platform/versioning-and-deprecation.md

What is available

Public REST API at https://api.fabhub.app/v1, described by OpenAPI.

Official TypeScript SDK (@fabhub/sdk) for typed server-side integrations.

Curated MCP server (@fabhub/mcp) whose tools map one-to-one to public API scopes.

Signed outbound webhooks with a generated AsyncAPI event contract.

API keys for tenant-owned automation and OAuth for approved partner applications.

Conventions

Base URL: https://api.fabhub.app/v1. Every path in this reference is relative to it.

Format: request and response bodies are JSON; request bodies use camelCase keys.

Query parameters use snake_case (for example page_size, contact_types).

IDs are UUID strings. Timestamps are ISO 8601 in UTC (for example 2026-06-20T09:30:00Z).

Authentication: send an API key in the X-API-Key header (or Authorization: Bearer). See Authentication.

Money fields (salePrice, purchasePrice) are numbers in the tenant's base currency, or null.

Core concepts

Tenant: every credential belongs to one tenant (organization); all data is tenant-scoped.

Scopes: keys carry least-privilege scopes such as items:read or webhooks:write.

Idempotency: write requests take an Idempotency-Key so retries are safe. See Idempotency.

Pagination: lists are page-based; audit export is cursor-based. See Pagination.

Errors: a stable JSON envelope with a machine-readable code. See Errors.

Public-safe source documents

The portal is generated from public-safe developer-platform sources registered in docs/developer-platform/docs-source-registry.json:

docs/developer-platform/api-changelog.md

docs/developer-platform/enterprise-controls.md

docs/developer-platform/hosted-mcp.md

docs/developer-platform/openapi-breaking-change-policy.md

docs/developer-platform/scope-taxonomy.md

docs/developer-platform/usage-endpoint.md

docs/developer-platform/webhook-events.md

docs/developer-platform/versioning-and-deprecation.md