Docs
View as Markdown

bitbucket.watchers

stable Advanced

Watchers of a Bitbucket repository.

GET /v1/bitbucket/watchers

What you get#

A list of Bitbucket results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
workspacestringyes(required)Bitbucket workspace slugmax 63 chars; must match [a-z0-9][a-z0-9_-]{0,62}; trimmed, lowercased
repostringyes(required)Repository slugmax 128 chars; must match [a-z0-9][a-z0-9._-]{0,127}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/bitbucket/watchers?workspace=atlassian&repo=aui" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Bitbucket response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "author": {
        "id": "{02b941e3-cfaa-40f9-9a58-cec53e20bdc3}",
        "username": null,
        "displayName": "Atlassian",
        "url": "https://bitbucket.org/%7B02b941e3-cfaa-40f9-9a58-cec53e20bdc3%7D/",
        "avatarUrl": "https://bitbucket.org/account/atlassian/avatar/"
      }
    },
    {
      "author": {
        "id": "{e4b8ab9c-6179-4830-b03f-e0709d26112a}",
        "username": "Richard Atkins",
        "displayName": "Richard Atkins",
        "url": "https://bitbucket.org/%7Be4b8ab9c-6179-4830-b03f-e0709d26112a%7D/",
        "avatarUrl": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557057:b345d451-4f10-4ff5-813a-97a6fd1d0b52/29f7d822-cb2b-42c5-ba48-959924af2c11/128"
      }
    }
  ],
  "metadata": {
    "platform": "bitbucket",
    "endpoint": "watchers",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
uuidauthor.id-
nicknameauthor.username-
display_nameauthor.displayName-
links.html.hrefauthor.urlsafeUrl
links.avatar.hrefauthor.avatarUrlsafeUrl

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).