Skip to content

List App Installs

GET
/apps/{app_id}/installs

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.

List the client organizations that installed this app, and their consent state.

Includes revoked and pending installs, not only consented ones — a builder debugging “why can’t my app reach this tenant” needs to see the revocation, and hiding it turns a clear answer into a mystery.

Authorizations

Parameters

Path Parameters

app_id
required
string

Header Parameters

X-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>

One client org’s install of an app. Mirrors InstallationDto.

object
app_id
required
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