Authentication
Create scoped tokens and keep API access limited to the workspaces you need.
RanklyBee uses scoped bearer tokens. Create and manage them from Settings → API access.
Send the token
Authorization: Bearer rk_live_your_tokenTokens are shown only once and stored only as a hash. Store them in a server-side secret manager. Do not put them in browser code, URLs, logs, or public repositories.
Scopes
Use the smallest set of scopes required by the integration:
| Scope | Used for |
|---|---|
workspaces:read | List workspaces available to the token. |
sites:read | List websites in a workspace. |
prospects:read | Read discovered prospects. |
prospects:write | Start discovery and update prospect status. |
contacts:read | Read website and prospect contacts. |
contacts:write | Discover, select, and verify contacts. |
outreach:read | Read drafts and conversations. |
outreach:write | Create, edit, and regenerate drafts. |
outreach:send | Queue outreach and send replies. |
keywords:read | Read a site's keyword profile. |
email-accounts:read | Read safe mailbox status. |
blocked-domains:read | Read blocked discovery domains. |
blocked-domains:write | Block or unblock discovery domains. |
jobs:read | Read prospect discovery job status. |
backlinks:read | Read tracked backlink data. |
Workspace access
A token can be restricted to selected workspaces. Requests outside that selection are not available to the token. Treat SCOPE_REQUIRED and NOT_FOUND as integration errors and do not retry them blindly.
Use read scopes for API integrations
The public API documented here is read-only. Plugin automation handles third-party submission workflows outside this API reference.