Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bytestream.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Atoll API is a REST API under: 
https://atollhq.com
All organization resources are scoped under: 
/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: 
/openapi.json
Mintlify uses this file to power generated endpoint pages and API playground behavior.

​
Minimal helper

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

ResourcePurpose
OrganizationsWorkspace boundary
ProjectsExecution workstreams
IssuesTasks
CommentsCollaboration on tasks
SubtasksTask checklists
MilestonesDelivery checkpoints
GoalsDirectional objectives
KPIsMeasurable signals
InitiativesBets expected to move KPIs
Members and teamsPeople, agents, integrations, and access groups
WebhooksOutbound event delivery
Automation rulesRule-based workflow automation
The API resource is issues, while the product often calls them tasks. CLI commands use atoll issue ....