API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Invitations

AdminUpdated Sep 11, 2026

Invitations

Backend API — secret key (Authorization: Bearer sk_…).

3 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/invitations

invitations:read

List instance-level invitations, cursor-paginated.

POST /v1/invitations

invitations:write

Create an instance-level invitation. On matching-email sign-up its public_metadata is copied onto the new user. Expires in 7 days.

POST /v1/invitations/:id/revoke

invitations:write

Revoke a pending instance invitation so it can no longer be accepted.

Was this page helpful?