Skip to content

REST API: API keys and scopes

Create an API key, understand the read / write / approve scopes, the main endpoints and how to revoke a key.

Updated:

With the REST API you can submit ideas from code, fetch upcoming posts and the week plan, or create drafts. You authenticate with an API key: every request carries the header Authorization: Bearer <key>.

Before you start

  • Only a workspace owner can create and revoke API keys.
  • On the Solo plan keys can only read; writing needs Pro or higher. If the trial has ended or the subscription isn't active, keys are read-only.

Create a key

  1. Open Settings → All integrations and click the REST API card.
  2. Enter what it's for (the field hint says What for? (e.g. Zapier)).
  3. Click New key.
  4. Copy the key with Copy – you only see it now (API key (you'll only see it now):).

A key made here can read and write (drafts, ideas) but not approve. To pick the scopes yourself, open the Claude & ChatGPT (MCP) card, tick them under Scoped API keys and click Create key.

Scopes

  • read – brands, channels, plan, posts, ideas, calendar summary, analytics.
  • write – write and edit drafts, ideas, generate a week, delete unsent posts.
  • approve – approval, i.e. real scheduling. The workspace must also allow it under Approvals from assistants, and all approval rules apply.

Common endpoints

Submit an idea: POST /api/v1/ideas {"text":"…"} · upcoming posts: GET /api/v1/posts?days=14 · week plan: GET /api/v1/week. The full list, error codes and per-minute limits are on the developer page.

Revoke a key

  1. Open the REST API card.
  2. Click Revoke in the key's row and confirm. Anything using the key stops working immediately.

Open in Sayweek

Was this article helpful?

Can't find the answer?

Write to us: hello@sayweek.com

REST API: API keys and scopes – Help center | Sayweek