Skip to content

Install App

POST
/installed-apps

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).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A client workspace consenting to an app.

object
app_id
required

The app to install, e.g. dapp_a1b2c3d4e5f6.

string
scopes

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.

Array<string>
<= 32 items

Responses

201

Successful Response

object
data
required

An app installed in your workspace, and what you granted it.

object
app_id
required
string
app_name
Any of:
string
app_slug
Any of:
string
client_org_id
required
string
consented_scopes
Array<string>
created_at
Any of:
string format: date-time
install_id
required
string
revoked_at
Any of:
string format: date-time
status
required

pending, consented, revoked, suspended or expired.

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string