# List apps in the platform console

> The platform.apps.list operation: GET /api/v1/platform/apps in the REST API and the platform_apps_list tool in the MCP server.

Registered apps of every organization (spec §41.3), newest first: `query` finds one by its ID (`ocl_…`) or part
of its name; `suspension` lists the apps Ownrecord suspended (`suspended`), reinstated (`reinstated`) or ever
suspended (`any`). Each has its publisher, owning organization, listing and suspension. Open one with
`platform.apps.get`. Platform staff.

## At a glance

- **REST:** `GET /api/v1/platform/apps`
- **MCP tool:** `platform_apps_list`
- **Operation ID:** `platform.apps.list`
- **Scope:** Platform
- **Permission:** `platform:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test and live
- **Pagination:** `limit` (at most 100) and `starting_after`
- **Authentication:** API key with the `platform:read` scope
- **Since:** M13

## Request

### Query parameters

| Field            | Type                                    | Required | Description                                                                 |
| ---------------- | --------------------------------------- | -------- | --------------------------------------------------------------------------- |
| `query`          | string                                  | No       | An app ID (`ocl_…`) or part of its name.                                    |
| `suspension`     | one of `suspended`, `reinstated`, `any` | No       | Only apps under suspension (`suspended`), reinstated ones, or both (`any`). |
| `limit`          | integer (1 to 100)                      | No       | Page size, 1 to 100 (default 10).                                           |
| `starting_after` | `ocl_…` ID                              | No       | The `next_cursor` of the previous page.                                     |

## Response

`200 OK` with a JSON object, a page of the list (newest first):

| Field                 | Type                                                                           | Description |
| --------------------- | ------------------------------------------------------------------------------ | ----------- |
| `object`              | `"list"`                                                                       |             |
| `data`                | array of object                                                                |             |
| `data[].id`           | `ocl_…` ID                                                                     |             |
| `data[].object`       | `"platform_app"`                                                               |             |
| `data[].name`         | string                                                                         |             |
| `data[].publisher`    | string                                                                         |             |
| `data[].org`          | object                                                                         |             |
| `data[].org.id`       | `org_…` ID                                                                     |             |
| `data[].org.slug`     | string                                                                         |             |
| `data[].org.name`     | string                                                                         |             |
| `data[].visibility`   | one of `private`, `listed`                                                     |             |
| `data[].listed`       | boolean                                                                        |             |
| `data[].reviewStatus` | one of `not_submitted`, `pending`, `changes_requested`, `approved`, `rejected` |             |
| `data[].status`       | one of `active`, `disabled`                                                    |             |
| `data[].suspension`   | object or null                                                                 |             |
| `data[].createdAt`    | date-time                                                                      |             |
| `data[].updatedAt`    | date-time                                                                      |             |
| `has_more`            | boolean                                                                        |             |
| `next_cursor`         | string or null                                                                 |             |

## Examples

### Apps under suspension

```http
GET /api/v1/platform/apps?suspension=suspended
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "ocl_01m4ttwd3veh9apbewxheq5xha",
      "object": "platform_app",
      "name": "Ledgerly AI",
      "publisher": "Ledgerly AI B.V.",
      "org": {
        "id": "org_01m4ttwd3veh9apbewxheq5xhb",
        "slug": "ledgerly",
        "name": "Ledgerly"
      },
      "visibility": "listed",
      "listed": true,
      "reviewStatus": "approved",
      "status": "active",
      "suspension": {
        "status": "suspended",
        "reason": "Its client secret was published in a public repository; tokens were used from unknown networks.",
        "suspendedAt": "2026-11-01T08:30:00.000Z",
        "reinstatedAt": null,
        "reinstateReason": null,
        "suspendedBy": "usr_01m4ttwd3veh9apbewxheq5xhg",
        "reinstatedBy": null
      },
      "createdAt": "2026-10-25T09:00:00.000Z",
      "updatedAt": "2026-11-01T08:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Errors

| Code                                                                                   | HTTP status | When                                     | What to do                                                                      |
| -------------------------------------------------------------------------------------- | ----------- | ---------------------------------------- | ------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed) | 400         | A filter or pagination value is invalid. | Fix the fields listed in `details.issues` and send the request again.           |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied) | 403         | You aren't platform staff.               | 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): [`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).