Partners

The cross-client overview (behind PARTNER_OVERVIEW_ENABLED)

Changed on

One row per client the caller may see (partner admins every active client, other staff the clients where they hold a grant), for a period preset in UTC calendar months. A row carries emissions by scope (tCO2e, through the same basis as that client's own Overview), months with data, and the work waiting only for the business organizations the access resolver lets the caller read (an active grant; viewer is enough). Otherwise access is none, lockedReason says why, and metrics and work are omitted. Sandboxes are never counted. A client whose reads failed or ran out of time has status unavailable (retry it with clientId); 503 QUERY_TIMEOUT only when every readable client failed. A clientId outside the visible set answers 404. Access is checked on every request; a readable client's figures and work counts may be reused for up to 30 s for the same caller, period and readable organizations. Each read client records partner.overview_viewed in its activity (after the response), at most once per user per hour. 404 for API keys, impersonated sessions and anyone who is not staff of the session's partner, and while PARTNERS_ENABLED or PARTNER_OVERVIEW_ENABLED is off.

get/partner/overview

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/partner/overview
  • Auth: HTTP bearer

Query parameters

period'this-year' | 'last-year' | 'last-12-months'

this-year is 1 January to the last complete month (in January, the month so far); last-year the previous calendar year; last-12-months the twelve complete months to the last one.

clientIdstring

One client's account id, to reload its row.

Response

The overview

Example response

{
  "data": {
    "period": {
      "label": "Jan–Sep 2026"
    }
  }
}

Changes