Skip to content

List an app's installations

The apps.installations operation: GET /api/v1/apps/{id}/installations in the REST API and the apps_installations tool in the MCP server.

GET/api/v1/apps/{id}/installations

For the publisher of a registered app: the organizations that installed it, newest first (at most 100), with the scopes they granted and the installation's status. Each API call the app makes names one of them with Ownrecord-Org when its token covers several.

At a glance

  • REST: GET /api/v1/apps/{id}/installations
  • MCP tool: apps_installations
  • Operation ID: apps.installations
  • Scope: Organization
  • Permission: agents:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Authentication: API key with the agents:read scope
  • Since: M10

Request

Path parameters

FieldTypeDescription
idocl_… ID

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

FieldTypeDescription
object"list"
dataarray of object
data[].idains_… ID
data[].orgIdorg_… ID
data[].orgNamestring
data[].scopesarray of one of 84 values, e.g. org:read, org:write, org:admin (all in the OpenAPI document)
data[].statusone of active, paused, revoked
data[].createdAtstring
data[].updatedAtstring

Examples

Where an app is installed

HTTP
GET /api/v1/apps/ocl_01m4ttwd3veh9apbewxheq5xha/installations
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "ains_01m4ttwd3veh9apbewxheq5xhc",
      "orgId": "org_01m4ttwd3veh9apbewxheq5xh3",
      "orgName": "Acme",
      "scopes": ["filings:read", "filings:write", "tasks:read", "tasks:write"],
      "status": "active",
      "createdAt": "2026-10-25T09:00:00.000Z",
      "updatedAt": "2026-10-25T09:00:00.000Z"
    }
  ]
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404Your organization registered no app with this ID.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
permission_denied403You can't see the organization's apps.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.