# Get the platform console overview

> The platform.overview\.get operation: GET /api/v1/platform/overview in the REST API and the platform_overview_get tool in the MCP server.

The platform console's home (spec §39.1): organizations by status, legal entities waiting for document review,
support-access requests waiting for an organization's decision and grants active now, open AUP reports, and the
system's dead jobs and undispatched outbox rows (`system.status`: `critical` with dead jobs, `warning` with a
backlog). Counts only.

## At a glance

- **REST:** `GET /api/v1/platform/overview`
- **MCP tool:** `platform_overview_get`
- **Operation ID:** `platform.overview.get`
- **Scope:** Platform
- **Permission:** `platform:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test and live
- **Authentication:** API key with the `platform:read` scope
- **Since:** M12

## Request

### Query parameters

This operation takes no query parameters.

## Response

`200 OK` with a JSON object:

| Field                    | Type                               | Description |
| ------------------------ | ---------------------------------- | ----------- |
| `object`                 | `"platform_overview"`              |             |
| `at`                     | date-time                          |             |
| `organizations`          | object                             |             |
| `organizations.total`    | integer                            |             |
| `organizations.byStatus` | object                             |             |
| `verificationsPending`   | integer                            |             |
| `supportRequestsWaiting` | integer                            |             |
| `supportGrantsActive`    | integer                            |             |
| `openAupReports`         | integer                            |             |
| `system`                 | object                             |             |
| `system.status`          | one of `ok`, `warning`, `critical` |             |
| `system.deadJobs`        | integer                            |             |
| `system.outboxPending`   | integer                            |             |

## Examples

### A quiet morning

```http
GET /api/v1/platform/overview
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "platform_overview",
  "at": "2026-11-03T09:00:00.000Z",
  "organizations": {
    "total": 214,
    "byStatus": {
      "active": 209,
      "restricted": 3,
      "suspended": 1,
      "closing": 1
    }
  },
  "verificationsPending": 2,
  "supportRequestsWaiting": 1,
  "supportGrantsActive": 1,
  "openAupReports": 0,
  "system": {
    "status": "ok",
    "deadJobs": 0,
    "outboxPending": 0
  }
}
```

## Errors

| Code                                                                                   | HTTP status | When                                                                | What to do                                                                      |
| -------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied) | 403         | You aren't platform staff with read access to the platform console. | Ask an organization owner or admin for a role or scope that allows this action. |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed), [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found), [`dry_run_not_supported`](https://ownrecord.io/docs/reference/errors.md#dry_run_not_supported), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).