RanklyBee Public API

The RanklyBee Public API is a scoped, read-only REST API for workspace integrations, prospecting, outreach, reporting jobs, and scheduled data workflows. Backlink submissions remain a plugin automation capability and are intentionally outside this API reference.

New here?

Follow the Quickstart to create a scoped token and make your first authenticated read request.

Browse the endpoints

The interactive reference groups the live endpoints by resource and marks every operation with its HTTP method. Open the API reference in this documentation site. Each operation page includes request examples, response schemas, and an interactive playground.

Start here

Quickstart

Create a token and make your first authenticated read request.

Authentication

Understand scopes, token storage, and workspace access.

API reference

Browse the grouped Account, Workspaces, Sites, Prospects, Contacts, Drafts, Inbox, Keywords, Email Accounts, Blocked Domains, Discovery Jobs, and Backlinks endpoints.

Base URL

Production requests use:

https://api.ranklybee.com/api/public/v1

Local development uses http://localhost:3001/api/public/v1. The /v1 prefix is part of the public contract and future breaking changes will use a new version.

What you can build

Workspace reporting

Read workspace, website, prospect, contact, and backlink data for reports and internal tools.

Backlink reporting

Read tracked backlinks, statuses, targets, and observation timestamps.

Workspace operations

Discover accessible workspaces and the websites linked to each one.

Scheduled data jobs

Use the read endpoints from reporting pipelines and internal tools.

Outreach operations

Read contacts, generated drafts, sender status, and inbox conversations.

Prospect discovery

Read prospects, keywords, blocked domains, and discovery job progress.

Request flow

Most read-only integrations follow the same sequence:

Create a scoped token in Settings → API access and keep it in a server-side secret manager.

List the workspaces available to the token.

List the websites linked to the selected workspace.

Read prospects, contacts, drafts, inbox conversations, or backlinks as needed.

Store the response data in your reporting or internal workflow.

Protect API tokens

Never expose a token in browser code, URLs, logs, or public repositories. Use a development workspace while building an integration.

Rate limits and retries

Each token can make up to 100 requests per minute, with up to 10 active tokens. See Rate limits for response headers and retry behavior.