SynqDocs
Management APIInvites

List the invites waiting for you

The invites sent to the signed-in person's verified email address that they can still accept: what each offers, as `POST /v1/invites/lookup` says it, and its id, to accept with `POST /v1/invites/{invite}/accept`. None while the address isn't verified. Oldest first. A person only, never an API key.

GET/v1/invites

The invites sent to the signed-in person's verified email address that they can still accept: what each offers, as POST /v1/invites/lookup says it, and its id, to accept with POST /v1/invites/{invite}/accept. None while the address isn't verified. Oldest first. A person only, never an API key.

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

Query Parameters

limit?integer

At most this many items, 200 at the most.

Range1 <= value <= 200
Default50
cursor?string

The 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

curl -X GET "https://api.synq.build/v1/invites" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "data": [    {      "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",      "id": "inv_01h455vb4pex5vsknk084sn02q"    }  ],  "next_cursor": "string"}