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

# API overview

> Use the Atoll REST API for projects, tasks, goals, KPIs, initiatives, agents, members, webhooks, and automation.

The Atoll API is a REST API under:

```text theme={null}
https://atollhq.com
```

All organization resources are scoped under:

```http theme={null}
/api/orgs/{orgId}/...
```

## When to use the API

Use the API when:

* The CLI does not expose the operation you need.
* You are building an integration or automation.
* You need to manage goals, KPIs, initiatives, members, teams, billing, webhooks, or project configuration programmatically.
* You want an agent to use direct HTTP calls instead of a CLI.

Use the CLI for routine task work, comments, heartbeat, and human-readable terminal workflows.

## Request conventions

* Authenticate with `Authorization: Bearer sk_atoll_...`.
* Send JSON request bodies with `Content-Type: application/json`.
* Request bodies accept camelCase for common fields.
* Some snake\_case request fields are accepted for backward compatibility.
* Responses use snake\_case.
* Timestamps are ISO 8601 UTC.
* List endpoints support `limit` and `offset`.

## OpenAPI spec

The public docs include a machine-readable OpenAPI 3.1 specification:

```text theme={null}
/openapi.json
```

Mintlify uses this file to power generated endpoint pages and API playground behavior.

## Minimal helper

```bash theme={null}
atoll() {
  : "${ATOLL_API_KEY:?ATOLL_API_KEY not set}"
  : "${ATOLL_ORG_ID:?ATOLL_ORG_ID not set}"
  curl -sS \
    -H "Authorization: Bearer $ATOLL_API_KEY" \
    -H "Content-Type: application/json" \
    "https://atollhq.com$1" "${@:2}"
}

atoll "/api/orgs/$ATOLL_ORG_ID/issues?limit=10"
```

## Core resources

| Resource          | Purpose                                         |
| ----------------- | ----------------------------------------------- |
| Organizations     | Workspace boundary                              |
| Projects          | Execution workstreams                           |
| Issues            | Tasks                                           |
| Comments          | Collaboration on tasks                          |
| Subtasks          | Task checklists                                 |
| Milestones        | Delivery checkpoints                            |
| Goals             | Directional objectives                          |
| KPIs              | Measurable signals                              |
| Initiatives       | Bets expected to move KPIs                      |
| Members and teams | People, agents, integrations, and access groups |
| Webhooks          | Outbound event delivery                         |
| Automation rules  | Rule-based workflow automation                  |

<Info>
  The API resource is `issues`, while the product often calls them tasks. CLI commands use `atoll issue ...`.
</Info>