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

# Introduction

> Integrate Flozy's CRM data into your own tools and workflows.

The Flozy External API lets you read and write leads, tasks, opportunities, contacts, pipelines, and custom fields programmatically — from your own scripts, automations, or integrations.

## Base URL

All endpoints are relative to:

```
https://api.flozy.com/api/v1/external
```

## Response shape

Every response follows the same envelope:

```json theme={null}
{
  "http_code": 200,
  "status": "success",
  "message": "Human-readable message",
  "data": { ... }
}
```

Errors use `"status": "failed"` with the same shape.

## Quick start

<Steps>
  <Step title="Create an API key">
    Go to **Settings → API Keys** in your Flozy dashboard. You must be the agency owner.
  </Step>

  <Step title="Choose your scopes">
    Select only the scopes your integration needs. See the [full scope list](/authentication#scopes).
  </Step>

  <Step title="Make your first request">
    ```bash theme={null}
    curl https://api.flozy.com/api/v1/external/leads \
      -H "X-API-Key: flz_live_your_key_here"
    ```
  </Step>
</Steps>

## Resources

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    How to send your API key and manage scopes.
  </Card>

  <Card title="Rate Limits" icon="gauge" href="/rate-limits">
    100 req/min per key, 200 req/min per IP.
  </Card>

  <Card title="Leads" icon="user" href="/api-reference/leads/overview">
    The core resource — prospects and clients.
  </Card>

  <Card title="Tasks" icon="check" href="/api-reference/tasks/overview">
    Standalone tasks or linked to leads.
  </Card>

  <Card title="Opportunities" icon="chart-line" href="/api-reference/opportunities/overview">
    Pipeline deals linked to leads.
  </Card>

  <Card title="Contacts" icon="address-book" href="/api-reference/contacts/overview">
    People associated with leads.
  </Card>
</CardGroup>