Apps

Get app

Get one Custom App by its slug.

GET/apps/{slug}

Get one Custom App by its slug. Use the slug from Register app or List apps.

A private app from another organization returns 404.

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.

Path

slugstringrequiredpath

slug of the app.

Response

A 200 response returns the app.

app_idstringrequired

Id of the app (app_...).

slugstringrequired

Identifier of the app. Use it on 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.

created_atstringrequired

When the app was registered.

updated_atstringrequired

When the app was last updated.

curl -X GET "https://api.cloud.blnkfinance.com/apps/stripe-sync" \
  -H "X-blnk-key: CLOUD_API_KEY"

{
  "app_id": "app_049495fe-6f03-4e7b-b3b4-7b0466c127c7",
  "slug": "stripe-sync",
  "name": "Stripe Sync",
  "description": "Sync Stripe payments into the ledger.",
  "logo_url": "https://app.example.com/logo.png",
  "developer_name": "Example",
  "registration_callback_url": "https://app.example.com/api/callback",
  "portal_generator_url": "https://app.example.com/api/portal",
  "permissions": ["data:read", "data:write"],
  "is_private": true,
  "organization_id": "org_01K4EX0C3A9F2B7D6E1C8A5F40",
  "assigned_to": [],
  "require_password_to_launch": false,
  "created_at": "2026-04-21T12:00:00Z",
  "updated_at": "2026-04-21T12:00:00Z"
}

{
  "error": "App not found"
}

{
  "error": "Organization not found"
}