Invites

Invites bring new people into your organization. The API sends the same email invitation as Settings → Members → Invite in the Console; the person becomes a member when they accept. Use it to onboard a new team from a script or from your own HR or provisioning tool.

Endpoints

Authenticate with an admin key and send syntic-beta: admin-2026-11-01. Keys created by Owners and Administrators may invite.

The invite object

{
  "id": "invite_01JCD3F5H7K9M1P3R5T7",
  "type": "invite",
  "email": "sam@example.com",
  "role": "developer",
  "workspaces": [{ "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q", "role": "workspace_developer" }],
  "status": "pending",
  "invited_by": { "id": "user_01J9...", "email": "ops@example.com" },
  "created_at": "2026-11-05T10:00:00Z",
  "expires_at": "2026-11-12T10:00:00Z",
  "accepted_at": null
}

Create an invite

POST /v1/organizations/invites

curl -sS https://app.syntic.ai/v1/organizations/invites \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -H "syntic-beta: admin-2026-11-01" \
  -d '{"email": "sam@example.com", "role": "developer",
       "workspaces": [{"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q", "role": "workspace_developer"}]}'

const newHires = ['sam@example.com', 'lee@example.com']
for (const email of newHires) {
  const res = await fetch('https://app.syntic.ai/v1/organizations/invites', {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.SYNTIC_ADMIN_KEY}`,
      'Content-Type': 'application/json',
      'syntic-beta': 'admin-2026-11-01',
    },
    body: JSON.stringify({ email, role: 'developer' }),
  })
  const body = await res.json()
  console.log(email, res.ok ? body.status : body.error.code)
}

import os, requests
 
H = {"Authorization": f"Bearer {os.environ['SYNTIC_ADMIN_KEY']}", "syntic-beta": "admin-2026-11-01"}
for email in ["sam@example.com", "lee@example.com"]:
    r = requests.post("https://app.syntic.ai/v1/organizations/invites", headers=H,
                      json={"email": email, "role": "developer"})
    print(email, r.json()["status"] if r.ok else r.json()["error"]["code"])

Response 201 Created with the invite. Inviting an address that already has a pending invite returns the existing invite with 200 OK rather than sending a second email; use /resend to send again.

Accepting

The invitee follows the link in the email, signs in or creates a Syntic account with that address, and becomes an active member with the invited role. Until then they cannot create keys or see anything in the organization. If your organization enforces single sign-on, they must sign in through your identity provider.

List, resend, cancel

• GET /v1/organizations/invites supports status (default pending), email and cursor pagination.
• POST .../resend issues a fresh link and moves expires_at 7 days forward. At most 5 resends per invite.
• DELETE .../{invite_id} cancels a pending invite; the link stops working. Returns {"id": "...", "type": "invite_deleted"}.

Each action writes an audit event: member.invited, member.invite_resent, member.invite_canceled, and member.joined on acceptance.

Errors

Errors use the error envelope.

Build notes for the platform team

• Thin wrapper over the existing invite and resend functions; keep the takeover guard that prevents an invite from overwriting an existing member’s row.
• The 7-day expiry belongs to the invite record; the email link itself is re-issued on each resend.

Related

• Members
• Workspaces
• Organizations & roles