Skip to main content
GET
List app installs

Authorizations

X-API-KEY
string
header
required

Query Parameters

previewAsClient
boolean

When true, an internal caller previews the install list as a client would see it.

Response

OK

appBuilderId
string
appId
string<uuid>

AppID is the identifier of the backing application, and the same value notifications carry in their appId so callers can join the two. Empty for embed, link, and manual installs, which have no backing app.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

autoSizeEmbed
boolean
content
string

extension

disabled
boolean

internal-api only module

displayName
string

DisplayName is the human-readable label shown for the install in the sidebar.

Example:

"Billing Portal"

embedCode
string
embedCount
integer
embedlyData
object
icon
string

Icon is the design-system icon name shown for the install; exposed on the public API.

id
string<uuid>

ID is the unique identifier of the app install. For core modules this is a deterministic UUID derived from the workspace and module name.

Example:

"550e8400-e29b-41d4-a716-446655440000"

isAuthenticated
boolean
isDraft
boolean

app-builder drafts: when the install was created by the App Builder and has not yet been deployed, IsDraft is true and AppBuilderID points to the source builder so the sidebar can deep-link to its session.

isInternalApp
boolean
isRoot
boolean
iuSidebarHidden
boolean
notificationConfig
object

NotificationConfig carries the backing app's declared notification settings so the IU notifications page can render a row per setting. Internal-only for now (omitexternal); exposing it on the public installs API is handled separately.

object
string
Example:

"appInstall"

path
string
queryParams
object[]
sort
integer
supportsExpiringTokens
boolean
type
enum<string>

Type is the kind of install.

Available options:
core,
custom,
marketplace,
embed,
link,
manual
Example:

"marketplace"

visibilityConfig
object[]