Get EnterpriseOpen Dashboard

This feature is only available in the Enterprise version

Apps

List apps

List the Custom Apps in the current organization.

GET/apps

List the Custom Apps in the current organization. Each app is private to that organization.

Send instance_id to see whether each app is installed on that instance.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Query

searchstringquery

Match on name, slug, or description. q is an alias for this parameter.

instance_idstringquery

Core instance (instance_...). When set, each app includes its install status on that instance. The caller has to be a user in the organization.

Response

A 200 response returns { "apps": [] }. Each item is an app.

app_idstringrequired

Id of the app (app_...).

slugstringrequired

Identifier of the app. Use it on Get app and Install app.

namestringrequired

Name shown in the Apps library.

descriptionstring

Short explanation of what the app does.

logo_urlstring

Public URL of the app logo.

developer_namestring

Company, team, or person that built the app.

registration_callback_urlstringrequired

URL Blnk calls on install and uninstall.

portal_generator_urlstring

URL Blnk calls to open the app.

permissionsstring[]

Scopes the app can be granted.

is_privatebooleanrequired

true when the app belongs to the current organization.

organization_idstring

Organization that owns the app.

assigned_tostring[]

User ids allowed to launch the app. Empty means every member.

require_password_to_launchbooleanrequired

Whether a launch asks for the account password again.

pinnedbooleanrequired

Whether the app is pinned in the sidebar for this instance. false when you omit instance_id.

created_atstringrequired

When the app was registered.

updated_atstringrequired

When the app was last updated.

statusstring

active when the app is installed on instance_id, and inactive when it is not. Present only when you send instance_id.

installed_app_idstring

Id of the installation (instapp_...). Present when status is active. Use it on Launch app and Uninstall app.

granted_permissionsstring[]

Scopes granted on that installation. Present when status is active.

pinned_atstring

When the app was pinned. Present when pinned is true.

can_launchboolean

true when this user may launch the app. Present only when you send instance_id.