Quickstart
Create a token, inspect a workspace, and read RanklyBee resource data.
This guide takes you from a scoped API token to your first workspace and read request. Use a development workspace 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 workspace ID returned by your account or workspace query.
List workspaces and websites
List the workspaces available to the token, then use one workspace ID to list its websites.
curl https://api.ranklybee.com/api/public/v1/workspaces \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"
curl "https://api.ranklybee.com/api/public/v1/workspaces/$RANKLYBEE_WORKSPACE_ID/sites" \
--header "Authorization: Bearer $RANKLYBEE_API_TOKEN"Read a resource
The API reference is grouped by resource. For example, read prospects for a workspace with optional search, status, and pagination filters:
curl "https://api.ranklybee.com/api/public/v1/workspaces/$RANKLYBEE_WORKSPACE_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.