Core Concepts
Scopes
Scopes decide what a key can do. Give each key only the ones it needs.
Each endpoint needs one scope, shown at the top of its reference page. A key without it gets 403 forbidden with the missing scope named in the message. Pick scopes when you create a key; to change them, create a new key and revoke the old one.
| Scope | Allows | Endpoints |
|---|---|---|
workspace:read | Read the workspace profile, company information and banned subreddits, and run content checks | Get Workspace Profile, Get Credits, Get Company Information, List Document Versions, List Banned Subreddits, Check Content |
workspace:write | Change the workspace profile and rewrite content | Update Workspace Profile, Rewrite Content |
posts:read | List and read posts and their review notes | List Posts, Get Post, List Post Review Notes, List Review Batches, Get a Review Batch, Get a Review Link, List a Client's Posts |
posts:write | Schedule, edit, approve and cancel posts, and leave review notes on them | Schedule a Post, Edit or Reschedule a Post, Approve a Post, Cancel a Post, Add a Post Review Note, Resolve Post Review Notes, Approve a Review Batch, Leave Batch Feedback, Reset a Review Link, Schedule a Post for a Client, Preview a Bulk Schedule, Confirm a Bulk Schedule |
comments:read | List and read comments and their review notes | List Comments, Get Comment, List Comment Review Notes, List a Client's Comments |
comments:write | Schedule, edit, approve and cancel comments, and leave review notes on them | Schedule a Comment, Edit or Reschedule a Comment, Approve a Comment, Cancel a Comment, Add a Comment Review Note, Resolve Comment Review Notes, Schedule a Comment for a Client |
analytics:read | Read Reddit results and AI search visibility | Get Reddit Performance, Get AI Search Visibility |
knowledge:write | Update company information and ban or unban subreddits | Update Company Information, Ban or Unban a Subreddit |
keywords:read | List keywords and target prompts | List Keywords, List Target Prompts |
keywords:write | Add and retire target prompts | Add Target Prompts, Retire a Target Prompt |
webhooks:read | List webhook endpoints and their recent deliveries | List Webhook Endpoints, Get a Webhook Endpoint, List Webhook Deliveries, List Agency Webhooks, Get an Agency Webhook, List Agency Webhook Deliveries |
webhooks:write | Create, change and delete webhook endpoints, and send test events | Create a Webhook Endpoint, Update a Webhook Endpoint, Delete a Webhook Endpoint, Send a Test Event, Create an Agency Webhook, Update an Agency Webhook, Delete an Agency Webhook, Send a Test Event to an Agency Webhook |
reports:read | List and read weekly gameplans, weekly summaries and performance reports | List Reports, Get a Report |
mentions:read | List mentions of your brand on Reddit | List Mentions |
notifications:read | List recent activity on your content: status changes, new replies and removals | List Activity |
strategy:read | Read the campaign strategy and list blog campaigns | Get the Campaign Strategy, List Blog Campaigns |
clients:read | Partner keys only. List and read your agency's clients | List Clients, Get a Client |
clients:write | Partner keys only. Add clients, change their name or reference, and invite a client login | Add a Client, Update a Client |
credits:read | Partner keys only. Read your agency's credit balance and each client's cap | Get Agency Credits, Get a Client's Credits |
List Workspaces needs no scope: any valid credential can see which workspaces it reaches.
