The Capacities API is a REST API that gives you programmatic access to a single workspace space per access token. You can read and write objects, properties, block content, daily notes, and more.

Base URL

All requests go to:

https://api.capacities.io

Paths in this documentation are relative to that host (for example GET /space/structures means https://api.capacities.io/space/structures).

What's in these docs

Overview

Fundamentals that apply to every request.

Concepts

Background knowledge for working with the API model.

Reference

The API Reference is the interactive OpenAPI specification — every endpoint, schema, rate limit, and TypeScript SDK sample. You can use it as a playground to test requests and see responses.

Quick start

1. Generate an access token in the Capacities desktop app under Settings → Capacities API. Choose a space and the scopes you need (api:read, api:write, or both).
2. Optionally install the TypeScript SDK (@capacities/api). Per-endpoint examples are in the API Reference.
3. Make your first requests:

import { CapacitiesClient } from '@capacities/api'

const capacities = new CapacitiesClient({
  apiToken: 'cap-api-…',
})

const space = await capacities.space.get()
const { structures } = await capacities.space.structures()

Or with curl:

curl https://api.capacities.io/space/structures \
  -H "Authorization: Bearer cap-api-…" \
  -H "X-Capacities-Api-Version: 0.1.0"

The token is bound to one space — you do not pass spaceId on each request. Use GET /space/structures to discover structure and property definitions before reading or writing objects.

Developer settings in the app

When you build integrations, you often need stable identifiers such as spaceId, structureId, and propertyId. In the Capacities desktop app, open Settings → Capacities API and scroll to Developer settings. Enable Show developer information to display these IDs in relevant places throughout the app — for example next to space, structure, and property settings. Click a badge to copy the value to your clipboard.

Working with multiple spaces

Each token works in one space only. To use the API in more than one space, create a separate token per space in Settings → Capacities API and use one client per token:

import { CapacitiesClient } from '@capacities/api'

const capacitiesPersonal = new CapacitiesClient({ apiToken: 'cap-api-…' }) // Personal space
const capacitiesWork = new CapacitiesClient({ apiToken: 'cap-api-…' }) // Work space