REST API

Search GroundUI's mobile app screens, get build briefs and fetch source code over a simple HTTP API.

The same library the MCP server uses, as JSON (and Markdown for briefs).

Base URL

https://groundui.dev/api/v1

Authentication

Search works without a key. Source code needs an API key from an account on a paid plan (Pro, Teams or Lifetime, see pricing). Create one in Settings → Agent access and send it with each request:

Authorization: Bearer gui_your_key

A key that is wrong, expired or revoked returns 401 instead of falling back to anonymous access.

Endpoints

Endpoint	Returns
`GET /screens?q=&category=&framework=&flow=&limit=&offset=`	Screens matching the search.
`GET /screens/:id?framework=`	One screen, with source on a paid plan.
`GET /screens/:id/brief?framework=&agent=`	The build brief as Markdown.
`GET /flows/:flow`	A flow's screens in order.
`GET /facets`	Categories, flows and frameworks to filter by.

framework is one of flutter, react-native, kotlin or swiftui. agent is one of claude-code, cursor, v0 or lovable.

Example

curl "https://groundui.dev/api/v1/screens?q=onboarding&framework=flutter&limit=1"

{
  "total": 27,
  "screens": [
    {
      "id": 377,
      "title": "Questions onboarding",
      "category": "onboarding",
      "frameworks": ["flutter", "react-native", "swiftui"],
      "access": "free",
      "image": "https://…",
      "url": "https://groundui.dev/template-details/377"
    }
  ]
}

Then get a brief for that screen:

curl "https://groundui.dev/api/v1/screens/377/brief?framework=flutter&agent=claude-code"

Authentication

Endpoints

Example

On this page