List the websites in your RankParse account and get the site_id values other endpoints need.

GET/v1/websitesFreeAPI key

Returns the websites in your workspace. Use the id as site_id in proposals, activity notes, agent tasks, the client report and outreach campaigns.

This is a small account lookup, not an SEO data call. It reads your own data only.

Request

Parameters

None. The workspace is the one your API key belongs to.

Example

curl "https://api.rankparse.com/v1/websites" \
  -H "X-API-Key: rp_your_key"

import requests

res = requests.get(
    "https://api.rankparse.com/v1/websites",
    headers={"X-API-Key": "rp_your_key"},
)
for site in res.json()["websites"]:
    print(site["id"], site["host"])

const res = await fetch("https://api.rankparse.com/v1/websites", {
  headers: { "X-API-Key": "rp_your_key" },
});
const { websites } = await res.json();
for (const site of websites) console.log(site.id, site.host);

Response

{
  "websites": [
    { "id": "site_abc123", "host": "example.com", "name": "Example" },
    { "id": "site_def456", "host": "shop.example.org", "name": "Example Shop" }
  ]
}

Response fields

Field	Type	Description
`id`	string	The website's id. Pass it as `site_id` wherever an endpoint asks for one.
`host`	string	The website's canonical host, for example `example.com`.
`name`	string	The website's display name in the dashboard.

Behavior and limits

Cost: 0 credits.
Archived websites are not listed, and their ids return 404 site_not_found on endpoints that take a site_id.
At most 200 websites are returned, ordered by name. There is no pagination.
Empty account: an account with no websites returns 200 with "websites": [].
Rate limit: 60 requests per minute per key.
Scope: the list is always your own workspace. Another workspace's websites are never visible, whatever you pass.