Skip to main content
GET
Read an app

Authorizations

Authorization
string
header
required

An API key from frogbot deploy's sign-in, /api/cli/device/token, or the API keys page.

Path Parameters

app
string
required

The app's slug, such as deals, or its id.

Query Parameters

secret
string

1 adds the app's secret to an owner's reply; an editor's has none, and an app staff removed answers 403.

Response

OK

id
string
required

A document id.

slug
string
required
name
string
required
workspace
string
required

A document id.

project
string | null
required

A document id.

url
string
required

https://<slug>.frogbot.app.

domain
string | null
required

The custom domain saved on the app; GET /api/apps/{app}/domain says whether it is live.

status
enum<string>
required
Available options:
removed,
paused,
live,
deploying,
failed,
not_deployed
deployment
string | null
required

The live deployment.

started
boolean
required
level
enum<string>
required
Available options:
editor,
owner
secret
string

The app's FROGBOT_SECRET, only for an owner who asks with ?secret=1, so a pulled copy keeps its connections and sign-ins (platform-28 D3).