Read a brand's sign-in page
Where each way to sign in goes (shown first, under More ways, or off, and for whom), what follows the email address, and what people coming back see. Needs `org.brands.view`.
/v1/orgs/{org}/brands/{brand}/sign-in-pageWhere each way to sign in goes (shown first, under More ways, or off, and for whom), what follows the email address, and what people coming back see. Needs org.brands.view.
Authorization
bearer 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
The org's id
^org_[0-9a-hjkmnp-tv-z]{26}$The brand's id
^brd_[0-9a-hjkmnp-tv-z]{26}$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/sign-in-page" \ -H "Authorization: Bearer $SYNQ_API_KEY"{ "methods": [ { "method": "google", "name": "Google", "kind": "provider", "placement": "shown", "off_for": null, "available": true, "link_only": false, "community_links": false, "icon_url": null } ], "max_shown": 4, "email": { "password": true, "code": true, "lead": "password" }, "returning": "last_only"}Who each way to sign in affects GET
For each way to sign in, how many of the brand's people have it as a way in, and how many of them have no other way in: what turning it off would do, before it's turned off. Counts only, never who. Needs `org.brands.view`.
Read a brand's numbers GET
A brand at a glance: its users, its monthly active users this month (the count the org's usage adds up toward its plan), its sign-ins started and finished and its new users over the last 7 days in UTC (finished over started is its sign-in success), and how many people signed in through each of its apps this month. Sign-ins through Synq's sign-in preview are a developer trying the page, and count in none of them. Needs `org.brands.view`.