Authentication
Create scoped RanklyBee API tokens, send them as bearer credentials, and keep access limited to the projects and data 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 |
|---|---|
projects:read | List projects available to the token. |
sites:read | List websites in a project. |
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. |
Project access
A token can be restricted to selected projects. 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. RanklyBee MCP uses separate OAuth authentication for guided third-party submission workflows.