Read what an invite offers
What an invite's link offers, while it can still be accepted: the org's name, the role across the org and the brand roles, each with what it lets the person do and each brand by its name, who sent it and when it stops working, for the page that asks before accepting. Public: it needs no credential, and the token is in the body, never the URL. It answers nothing else about the org, nor the address the invite was sent to. A few a minute from one address, or from one person signed in.
/v1/invites/lookupWhat an invite's link offers, while it can still be accepted: the org's name, the role across the org and the brand roles, each with what it lets the person do and each brand by its name, who sent it and when it stops working, for the page that asks before accepting. Public: it needs no credential, and the token is in the body, never the URL. It answers nothing else about the org, nor the address the invite was sent to. A few a minute from one address, or from one person signed in.
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
curl -X POST "https://api.synq.build/v1/invites/lookup" \ -H "Authorization: Bearer $SYNQ_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "token": "string" }'{ "org_name": "Acme", "role": "admin", "role_name": "Admin", "role_about": "Everything but handing the organization over or deleting it", "brand_roles": [ { "brand_name": "Acme Books", "role": "developer", "role_name": "Developer", "about": "Its apps, APIs, sign-in methods, webhooks and API keys" } ], "inviter_name": "Ana Lima", "expires_at": "2026-10-21T12:00:00.000Z"}Accept an invite waiting for you POST
One of the signed-in person's own pending invites (`GET /v1/invites`), by its id: their verified email address is the invite's, which proves it was sent to them. An invite to anyone else is 404, as one that never was. Recorded as `invite.accepted` and `member.added`.
Invite someone POST
Emails them a link, single-use and valid 7 days, to join with a role across the org and brand roles (left out, the role's: Brand admin on All brands for an admin, Viewer for a member, none for billing), at most the caller's own permissions, never owner. A role in one brand wants a plan with roles in one brand at a time (403 `plan_feature_unavailable`, Scale and up). They accept it signed in at Synq with that email. Needs `org.members.edit`. Recorded as `invite.created`.