List an org's brands
Oldest first. Needs `org.brands.view`.
/v1/orgs/{org}/brandsOldest first. 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
Query Parameters
At most this many items, 200 at the most.
1 <= value <= 20050The previous page's next_cursor, for the page after it.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/orgs/string/brands"{ "data": [ { "id": "string", "org_id": "string", "issuer_slug": "string", "issuer": "string", "custom_domain_issuer": "string", "name": "string", "is_default": true, "sign_up_enabled": true, "sign_in_cancels_deletion": true, "breached_password_check": true, "show_last_used": true, "built_in_methods": { "email": true, "password": true, "passkey": true, "wallet": true }, "logo_url": "string", "primary_color": "string", "background_color": "string", "support_email": "string", "privacy_policy_url": "string", "terms_of_service_url": "string", "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string"}Read a brand GET
Needs `org.brands.view`.
Change how a brand's email goes out PATCH
Who its email is from: one of the org's sending domains, on a plan with `branding.custom_email_domain` (it is used once the domain is verified, and `<brand> via Synq` meanwhile and whenever the plan or the domain stops allowing it), the part before the @ and the name, on every plan. Sets where replies to the brand's email go, on every plan, and keeps what isn't sent. A new reply-to address waits until someone who reads it opens the link Synq emails it (`status: pending_confirmation`); the caller's own verified address, and one on a sending domain the org verified, are confirmed at once. Needs `org.brands.edit`. Recorded as `brand.updated`, and the confirmation as `brand.reply_to_confirmed`.