The API: key, scopes and limits

Cool has a public REST API. It links your community to any system: pull members into your CRM, publish to the feed from your site, read payments into your accounting.

Getting the key

In the panel, Integrations → API. The key shows once, at creation — save it right then. Lose it and you generate another and revoke the old one.

Scopes

Each key has a scope:

• read — read only;
• write — read and write.

Create one key per integrated system, with the smallest scope that does the job. When one of them leaks, you revoke only that one.

Limits

Go over and the response comes back with the rate-limit code and how long to wait.

Endpoints

The main ones:

• GET /api/v1/me — checks the credential works and returns scopes and limits
• GET /api/v1/communities — your communities
• GET /api/v1/members — members
• GET /api/v1/payments — payments
• GET|POST /api/v1/posts — read and publish in the feed

The full reference, with curl examples and response shapes, is at /docs/api — public, no login.

Start with /me. It answers the only question that matters in the first minute: does the key work, and what can it do.