Get Bizstack App installations

GET/bizstackAppInstallations

Base URL: https://api.tinkermode.com

Get a list of Bizstack App installations within a specific project.

  • Note: The targetEntityId field specifies the ID of the entity under which the Bizstack App is installed for non-tenant installations.
  • For tenant installations, this field is empty.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain the key of a user or service account with permissions to read Bizstack App installations or a project API key.

Query parameters

NameTypeRequiredConstraintsDescription
bizstackAppIdstringNoReturn Bizstack App installations of the specified Bizstack App.
homeIdintegerNoReturn Bizstack App installations of the specified home (tenant).
limitintegerNoMaximum number of Bizstack App installations to return.
skipintegerNoNumber of Bizstack App installations to skip over.

Responses

200 Successfully retrieved the Bizstack App installations.

Content type: application/json

Represents a Bizstack App installation

An array of objects with the following shape:

PropertyTypeRequiredConstraintsDescription
appRootEntityIdstringNoread-only (server-generated)The entityID of the entity that is the root entity of the installed Bizstack App
appViewerAccessControlGroupIdstringNoread-only (server-generated)The identifier of the access control group that is used to control a view access to the installed Bizstack App resources
bizstackAppIdstringNoread-only (server-generated)The identifier of the Bizstack App installed with this installation
createdAtstringNoread-only (server-generated)The time the Bizstack App installation was created
homeIdintegerNoread-only (server-generated)Home that this Bizstack App installation belongs to
idstringNoread-only (server-generated)The unique identifier for the Bizstack App installation
projectIdintegerNoread-only (server-generated)Project that this Bizstack App installation belongs to
updatedAtstringNoread-only (server-generated)The time the Bizstack App installation was last updated

Response example

[
  {
    "appRootEntityId": "bizstackapp_root_test_bizstack_app_6889df544000476c4261cabc",
    "appViewerAccessControlGroupId": 89,
    "bizstackAppId": "test_bizstack_app",
    "createdAt": "2025-07-30T09:01:08.679Z",
    "homeId": 4567,
    "id": "6889df544000476c4261cabc",
    "projectId": 123,
    "targetEntityId": "tenant_root_abc",
    "updatedAt": "2025-07-30T09:01:08.79Z"
  }
]

401 Authorization is required to access this resource.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

403 Request failed because of denied permission.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

429 Request failed because of rate limit.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

500 An unexpected error has occurred.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.

503 The service is temporarily unavailable.

Content type: application/json

PropertyTypeRequiredConstraintsDescription
dataobjectNoread-only (server-generated)Any relevant data related to error.
reasonstringYesread-only (server-generated)Reason of error.