NewSend finished articles to WordPress, Shopify or any site, as drafts you approve.Publish articles to WordPress and Shopify.

The API

Read your Citeroot numbers as JSON from a dashboard, a spreadsheet or a script: how to sign in, what you can read, and the limits.


The API gives you your account's data as JSON, for a dashboard, a spreadsheet or a script of your own. It is read-only: nothing can be changed through it. It asks no AI platform and no AI model, so a request uses none of your answers or AI credits.

It is on the paid plans (Grow, Pro, Max and Enterprise).

#Sign in

  1. Open Settings → Connect AI apps.
  2. Under Tokens, type a name (for example "Looker Studio") and press Make a token.
  3. Copy the token. It is shown once.

Send it with every request, in the Authorization header:

curl -H "Authorization: Bearer YOUR_TOKEN" https://citeroot.app/api/v1/projects

Treat the token like a password. To stop it, press Remove beside it on the same page. It stops at once.

#What you can read

Every address starts with https://citeroot.app/api/v1/. All of them are GET.

AddressWhat it returnsParameters
projectsYour projects: id, name, website, country, competitors.none
visibilityNamed, cited and recommended rates with their ranges, the change on the period before, and each AI platform.platform, days (7 to 90, default 28)
questionsTracked questions with how often you are named.sort (named_low or newest), limit
answersThe latest answers, or one answer in full.id, question, platform, named (true or false), limit
competitorsYou and each competitor: share of answers and change.none
sourcesThe sites AI cites, by type.type, gaps_only, limit
site-healthThe latest website scan: score and findings.none
todoThe jobs on What to do next.none
planThe Plan board's jobs.none
docsThe documents in Docs.kind, search, limit

GET https://citeroot.app/api/v1 lists the same addresses with every parameter.

More than one project? Add project to the request, with the project's id, website or name:

curl -H "Authorization: Bearer YOUR_TOKEN" "https://citeroot.app/api/v1/visibility?project=example.com&days=28"

With one project you can leave it out.

#An example

GET /api/v1/competitors returns, in outline:

{
  "window": "last 28 days, against the 28 days before",
  "answers": 832,
  "brands": [
    { "name": "Competitor 1", "domain": "competitor-1.example", "named": { "pct": 63, "range": "59–66%", "of": "522 of 832" }, "before": 64, "change": "flat" },
    { "name": "Your brand", "you": true, "named": { "pct": 38, "range": "35–42%", "of": "319 of 832" }, "before": 23, "change": "flat" }
  ]
}

The names and numbers above are placeholders that show the shape. change is up or down only when the change is bigger than normal variation. See Reading changes and variance.

#Errors and limits

StatusWhat it means
400The request can't be answered as sent. The error text says why, for example which projects to choose from.
401No token, or a token that is wrong or removed.
403Your plan doesn't include the API.
404No such address.
429Too many requests. The limit is 120 a minute for each token. Wait a minute.

Every error is JSON with one field, error.

#What it doesn't do

  • It can't add or change questions, projects or competitors, and it can't start a check. Checks run on your plan's schedule.
  • There are no webhooks. To see new numbers, ask again after your next check.
  • The token reaches the account of the person who made it. Team members can't make one for the owner's account.
  • For AI apps such as Claude and ChatGPT, use the MCP server instead: it adds Citeroot's instructions to the same data. See Connect AI apps.

The addresses under /api/v1 will keep working. If a change would break them, it will get a new version.

Last updated Nov 15, 2026 · Suggest an edit