SynqDocs
Management APIClaimable orgs

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.

POST/v1/claimable-orgs/lookup

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.

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

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    }  ]}