Quickstart
Make your first RanklyBee API call in minutes: create a token, inspect a project, and read prospecting, outreach, and backlink data.
This guide takes you from a scoped API token to your first project and read request. Use a development project while testing.
Create an API token
Open Settings → API access and create a token with the scopes your integration needs. Copy it immediately; it is shown only once.
export RANKLYBEE_API_TOKEN="rk_live_your_token"Inspect the current account
curl https://api.ranklybee.com/api/public/v1/me \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"Save the project ID returned by your account or project query.
List projects and websites
List the projects available to the token, then use one project ID to list its websites.
curl https://api.ranklybee.com/api/public/v1/projects \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"
curl "https://api.ranklybee.com/api/public/v1/projects/$RANKLYBEE_PROJECT_ID/sites" \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"Read a resource
The API reference is grouped by resource. For example, read prospects for a project with optional search, status, and pagination filters:
curl "https://api.ranklybee.com/api/public/v1/projects/$RANKLYBEE_PROJECT_ID/prospects?page=1&limit=25" \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"You can use the same scoped token to read contacts, drafts, inbox conversations, keywords, email account status, blocked domains, discovery jobs, and tracked backlinks. Each resource group documents its required scope and filters.