Read what a claim token would claim
The org a claim token names, while it can be claimed: for the page that asks before claiming. A person only; the token is in the body, never the URL. `into_orgs` lists the orgs the caller may claim it into instead, as a new brand (`POST /v1/claimable-orgs/claim-into`), each with its room for one more.
/v1/claimable-orgs/lookupThe org a claim token names, while it can be claimed: for the page that asks before claiming. A person only; the token is in the body, never the URL. into_orgs lists the orgs the caller may claim it into instead, as a new brand (POST /v1/claimable-orgs/claim-into), each with its room for one more.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.synq.build/v1/claimable-orgs/lookup" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "claim_token": "synq_claim_…" }'{ "org": { "id": "string", "slug": "acme", "name": "Acme" }, "issuer": "string", "apps": 0, "users": 0, "expires_at": "2026-10-21T12:00:00.000Z", "into_orgs": [ { "id": "org_01h455vb4pex5vsknk084sn02q", "name": "Acme", "slug": "acme", "role": "owner", "plan": "pro", "brands": 2, "brand_limit": 3, "refusal": null } ]}Claim a claimable org POST
Makes the caller the owner of the org a claim token names: from then on it is an org like any other, on its plan's limits, and its sign-in pages no longer say it is unclaimed. Like making an org, it wants a person with a verified email address (`email_unverified`), where Synq takes tenants from them (`org_creation_closed`), owning fewer free orgs than one person may (`org_quota_exceeded`; orgs on a paid plan don't count). The token works once. Recorded as `org.claimed`. To add it to an org the caller has instead, as a brand, `POST /v1/claimable-orgs/claim-into`.
Make a claimable org POST
What `npx synqauth init` calls: an org with its default brand and one development app, made with no account and no credential, so a developer can sign someone in to their app on their laptop before signing up. Nobody is its member, so nothing can change it but claiming it. Until someone claims it with `claim.url` (or `POST /v1/claimable-orgs/claim`), its app takes https redirect URIs on a loopback address only, its brand takes 25 users and little email, and its sign-in pages say it is a development sign-in nobody has claimed. Unclaimed after 7 days, it is deleted. Only where Synq makes claimable orgs and is open for sign-up (`org_creation_closed` otherwise), and a few a day from one address. Recorded as `org.created` (`metadata.claimable`) and `app.created`, by `anonymous`.