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

# Quickstart

> Start integrating with Automate CRM in three simple steps.

Welcome to Automate CRM. Follow this guide to obtain your API credentials and execute your first authenticated request against the CRM Integration API.

## Prerequisites

Before getting started, make sure you have:

* Access to your Automate CRM workspace.
* Administrative permissions to generate integration API keys.
* A tool for making HTTP requests (such as `curl`, Postman, or Node.js).

**1. Step 1: Obtain your workspace API key**

Log in to your Automate CRM dashboard and navigate to **Settings** > **Developer & Integrations**. Generate a new API key with the required scopes:

* `crm:read`: Required for `GET`, `HEAD`, and `OPTIONS` requests.
* `crm:write`: Required for `POST`, `PATCH`, `PUT`, and `DELETE` requests.

> [!WARNING]
>
> Copy and securely store your API key immediately upon creation. For security reasons, the key will not be displayed again.

**2. Step 2: Understand workspace resolution**

Your API key implicitly identifies and isolates your workspace.

> [!NOTE]
>
> Do not include a workspace ID in request paths or request bodies. The server resolves all tenancy automatically from the `x-api-key` header.

**3. Step 3: Execute your first API call**

Make a request to list the leads currently in your workspace. Include your secret key in the `x-api-key` header:

```bash cURL theme={null}
curl --request GET \
  --url https://crm-api.automatebusiness.com/api/v1/integrations-public/leads \
  --header 'x-api-key: YOUR_WORKSPACE_API_KEY' \
  --header 'Content-Type: application/json'
```

```javascript Node.js theme={null}
const response = await fetch('https://crm-api.automatebusiness.com/api/v1/integrations-public/leads', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_WORKSPACE_API_KEY',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

headers = {
    "x-api-key": "YOUR_WORKSPACE_API_KEY",
    "Content-Type": "application/json"
}

response = requests.get(
    "https://crm-api.automatebusiness.com/api/v1/integrations-public/leads",
    headers=headers
)

print(response.json())
```

### Sample read response

```json theme={null}
{
  "status": "success",
  "code": 200,
  "message": "Integrations public retrieved successfully",
  "data": {
    "items": [],
    "pagination": {
      "total": 0,
      "page": 1,
      "limit": 20,
      "totalPages": 0
    }
  },
  "timestamp": "2026-10-26T10:00:00.000Z"
}
```

## Next steps

Now that you have authenticated with the CRM API, explore our core feature guides and endpoint references:

> [card] [Manage leads](https://docs.automatebusiness.com/automate-crm/features/leads.md)
>
> Learn how to create deals and transition them through pipeline stages.

> [card] [API authentication](https://docs.automatebusiness.com/automate-crm/api-reference/authentication.md)
>
> Read complete details on scopes, error handling, and security best practices.


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