> ## Documentation Index
> Fetch the complete documentation index at: https://developers.1-funnel.org/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference overview

> How the 1Funnel API reference is published.

The API reference is generated from approved contracts in this repository. It is the public description of the External Integration API.

<Note>
  The External Integration API is not generally available. Nothing on this page
  is a production endpoint, credential, or response schema.
</Note>

## REST

REST operations will be generated from OpenAPI 3.1 documents under `openapi/`. A document is public only after it is added to `docs.json` navigation and merged to `main`.

Synthetic files under `scripts/fixtures/` exist so CI can prove the linters work. They are not API operations and they are not linked from this site.

## Webhooks

Webhook channels will be generated from AsyncAPI 3.0 documents under `asyncapi/`, or described in MDX that cites a validated AsyncAPI file. Mintlify can render AsyncAPI 3.0. Rendering stays disabled in navigation until a contract is approved.

## Playground

The interactive API playground is set to `none` in `docs.json`. It stays off until the external API security model is approved. Do not enable it in the same change that introduces a draft contract.

## What you can rely on today

You can rely on the publication rules in [versioning](/api-reference/versioning) and on the fact that no production operation is listed yet. You cannot rely on paths, error bodies, limits, or authentication headers, because those belong to a contract that has not been approved.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.