Docs
View as Markdown

github.org_events

stable Advanced

Recent public events of a GitHub organisation.

GET /v1/github/org_events

What you get#

A list of GitHub 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.

Pagination: 10 results per page. The response carries a pagination block; send its next_cursor back as the cursor parameter to get the next page. Every page is one call at the price below. See Pagination.

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
orgstringyes(required)GitHub user or organisation loginmax 39 chars; must match [a-z0-9](?:[a-z0-9-]{0,38}); trimmed, leading @ removed, lowercased
cursorstringno-Opaque cursor from a previous response's pagination.next_cursor. Omit for the first page.-

Request#

curl "https://api.onekey.dev/v1/github/org_events?org=github" \
  -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 GitHub response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "15953454038",
        "createdAt": "2026-09-28T20:43:45Z"
      },
      "ext": {
        "action": "PullRequestEvent"
      },
      "author": {
        "username": "dependabot[bot]"
      },
      "entity": {
        "name": "github/copilot-sdk-workshop"
      }
    },
    {
      "content": {
        "id": "22418881497",
        "createdAt": "2026-09-28T20:43:44Z"
      },
      "ext": {
        "action": "CreateEvent"
      },
      "author": {
        "username": "dependabot[bot]"
      },
      "entity": {
        "name": "github/copilot-sdk-workshop"
      }
    }
  ],
  "metadata": {
    "platform": "github",
    "endpoint": "org_events",
    "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
idcontent.id-
typeext.action-
created_atcontent.createdAttoIsoDate
actor.loginauthor.username-
repo.nameentity.name-

Caching and freshness#

  • Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
  • Between 30 seconds and 5 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 10 minutes 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).