Skip to main content
GET
List mini apps
Returns the apps newest-updated first, with each app’s name, description, tags, surface, published version, draft, owner, and can_edit. What the list contains depends on who is calling:
  • An identified user with app read or write permission, or an admin, sees every app in the workspace, including apps that only have a draft.
  • Any other identified user sees only published apps shared with one of their roles. draft_version_id is always null for them.
  • A bare API key needs mini-apps:read, sees every app, and receives can_edit: false.
Narrow the list with any of these filters. Filters combine, so an app must match all of them: Use the app’s id with Read source to read its code or check whether you can edit it.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string

Case-insensitive substring match on the app name or description.

Maximum string length: 200
surface
enum<string>

Only apps on this surface (the surface each row reports in target_surface).

Available options:
inbox,
dashboard
tags

Comma-separated tags; an app matches when it has any of them, ignoring case.

Response

Default Response

mini_apps
object[]
required