API Reference

Apps

Browse, filter, and inspect apps in the Gummble library.

List apps

GET /api/v1/apps

Query parameters

NameTypeDescription
qstringFree-text search across name + slug
categorystring[]OR-filter on category names
platformIOS | ANDROID | WEBPlatform filter; lowercase URL tokens are accepted and normalized
limitnumberPage size (default 20, max 100)
cursorstringPagination cursor

Example

curl 'https://api.gummble.com/api/v1/apps?q=linear&limit=1' \
  -H "Authorization: Bearer $TOKEN"
{
  "data": [{
    "id": "app_01HXY...",
    "slug": "linear",
    "name": "Linear",
    "platforms": ["web", "ios"],
    "categories": ["Productivity"],
    "iconUrl": "https://storage.gummble.com/apps/linear/icon.webp",
    "previewScreenIds": ["sc_…", "sc_…"]
  }],
  "pagination": { "cursor": "...", "hasMore": true }
}

Get an app

GET /api/v1/apps/:slugOrId

Returns the full app payload including all screens and flows.

curl https://api.gummble.com/api/v1/apps/linear \
  -H "Authorization: Bearer $TOKEN"

App object

type App = {
  id: string                 // app_01HXY...
  slug: string               // 'linear'
  name: string
  description?: string
  platform: 'IOS' | 'ANDROID' | 'WEB'
  categories: string[]
  iconUrl: string
  websiteUrl?: string
  screens: Screen[]          // populated on GET /apps/:slug
  flows: Flow[]              // populated on GET /apps/:slug
}