SynqDocs
Management APIApps

Read an app's quickstart

What to install and the values to set to sign people in with the app, filled in with its own: its issuer, client_id and redirect URI. For a web app, `@synqauth/nextjs`'s route mount, and the redirect URI to add when it has none of the mount's; for a SPA, `@synqauth/js`; for a native app, the values for its OpenID Connect library; for machine and agent apps, client credentials. Never its secret: a placeholder says where it was shown. Needs `org.apps.view`.

GET/v1/orgs/{org}/brands/{brand}/apps/{app}/quickstart

What to install and the values to set to sign people in with the app, filled in with its own: its issuer, client_id and redirect URI. For a web app, @synqauth/nextjs's route mount, and the redirect URI to add when it has none of the mount's; for a SPA, @synqauth/js; for a native app, the values for its OpenID Connect library; for machine and agent apps, client credentials. Never its secret: a placeholder says where it was shown. Needs org.apps.view.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$
app*string

The app's client_id: an app_… id, or the URL of the metadata document an app registered itself with

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/apps/app_01h455vb4pex5vsknk084sn02q/quickstart" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "app_id": "app_01h455vb4pex5vsknk084sn02q",  "app_type": "web",  "issuer": "string",  "blocks": [    {      "title": "Install",      "file": ".env.local",      "code": "pnpm add @synqauth/nextjs @synqauth/react",      "note": "string"    }  ]}