---
title: "Install App"
method: POST
path: "/installed-apps"
tags: ["Installed Apps"]
---

# Install App

`POST /installed-apps`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/installed-apps`
- Auth: HTTP bearer

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Install an app into your workspace and grant it scopes.

Consent is recorded immediately — there is no pending step in the beta, and a
`pending` status that nothing ever advanced would be a trap. Re-installing an
app you already have UPDATES the grant in place, which is how you change
scopes; there is exactly one install row per (app, workspace).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- InstallAppRequest: A client workspace consenting to an app.
  - `app_id` string, required: The app to install, e.g. `dapp_a1b2c3d4e5f6`.
  - `scopes` string[]: Scopes you grant the app, e.g. `objects:read`. Only scopes the platform enables for apps are accepted; anything else is rejected rather than silently dropped, so a granted scope always means what it says.

## Response `201`

Successful Response

- ApiResponseInstalledAppResponse
  - `data` InstalledAppResponse, required: An app installed in your workspace, and what you granted it.
    - `app_id` string, required
    - `install_id` string, required
    - `client_org_id` string, required
    - `status` string, required: `pending`, `consented`, `revoked`, `suspended` or `expired`.
    - `consented_scopes` string[]
    - `created_at` string, date-time, nullable
    - `revoked_at` string, date-time, nullable
    - `app_name` string, nullable: The app's display name, when it is still resolvable.
    - `app_slug` string, nullable
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)