> ## Documentation Index
> Fetch the complete documentation index at: https://failfast.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Work with your Fail Fast workspace data over a REST API

The Fail Fast API is a REST API that gives external tools access to the same records your team works with in the app — stakeholders, quotes, orders, invoices, inventory, treasury records, CRM data, and tasks. Use it to connect integration platforms like n8n and Zapier or your own custom services.

## Base URL

All endpoints are served from:

```
https://api.failfast.ai
```

## Authentication

Every request needs a workspace API key sent as a bearer token:

```
Authorization: Bearer failfast_...
```

Keys are created in the app under **Settings → Workspace → API Keys**. See [Authentication](/docs/api-reference/authentication) for details, rate limits, and key management.

## Response envelope

Every response — success or failure — uses the same JSON envelope:

```json theme={null}
{
  "message": "Human-readable outcome",
  "error": false,
  "data": { }
}
```

* `message` describes what happened.
* `error` is `false` on success and `true` on failure.
* `data` carries the payload: a record, a paginated list, or error details.

The HTTP status code still signals the outcome class (2xx success, 4xx client error). See [Errors](/docs/api-reference/errors).

## Scope of this reference

This reference documents the core business entities — the stable, curated surface intended for external integrations. Each entity supports the standard operations: list, retrieve, create, update, and delete.

<Note>
  Deletes are logical: `DELETE` marks the record as deleted instead of removing it, and the record can be recovered from the app.
</Note>

Your API key acts on one workspace and inherits the permissions of the member it belongs to. Requests against entities the member cannot read or modify are rejected, and modules that are not enabled for the workspace hold no data.

## Related pages

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/docs/api-reference/authentication">
    API keys, rate limits, and key management.
  </Card>

  <Card title="Pagination and filtering" icon="filter" href="/docs/api-reference/pagination-and-filtering">
    Page through lists and narrow results with field filters.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/docs/api-reference/errors">
    Status codes and the error envelope.
  </Card>

  <Card title="API keys in the app" icon="gear" href="/docs/admin/api-keys">
    How administrators create and revoke keys.
  </Card>
</CardGroup>
