Get a Bizstack App installation

GET/bizstackAppInstallations/{bizstackAppInstallationId}

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

Return the Bizstack App installation with the specified ID.

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 with the admin operation permission.

Path parameters

Name	Type	Required	Constraints	Description
`bizstackAppInstallationId`	string	Yes		The unique ID of a Bizstack App installation.

Responses

`200` Successfully retrieved the Bizstack App installation with specified ID.

Content type: application/json

Property	Type	Required	Constraints	Description
`appRootEntityId`	string	No	read-only (server-generated)	The entityID of the entity that is the root entity of the installed Bizstack App
`appViewerAccessControlGroupId`	string	No	read-only (server-generated)	The identifier of the access control group that is used to control a view access to the installed Bizstack App resources
`bizstackAppId`	string	No	read-only (server-generated)	The identifier of the Bizstack App installed with this installation
`createdAt`	string	No	read-only (server-generated)	The time the Bizstack App installation was created
`homeId`	integer	No	read-only (server-generated)	Home that this Bizstack App installation belongs to
`id`	string	No	read-only (server-generated)	The unique identifier for the Bizstack App installation
`projectId`	integer	No	read-only (server-generated)	Project that this Bizstack App installation belongs to
`updatedAt`	string	No	read-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

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested bizstackAppInstallation does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.