API referenceInvitations
Invitation_create
POST
/invitationsRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/invitations" \ -H "Content-Type: application/json" \ -d '{ "email": "string" }'{ "invitation": { "cancelled_at": "string", "created_at": "string", "created_by": "string", "email": "string", "expires_at": "string", "id": "string", "org_id": "string", "redeemed_at": "string", "redeemed_user_id": "string", "role": "owner", "status": "pending", "team_ids": [ "string" ], "updated_at": "string" }, "redemption_url": "string", "token": "string"}`POST /invitations/bulk` — bulk invitation import. POST
Iterates rows independently. Each row goes through the same per-row checks the single-create endpoint runs (email validation, policy, role, team existence, throttle); per-row outcomes ride back in `BulkCreateInvitationResponse.results` so the admin sees partial success without scraping the audit log. Anti-enumeration doesn't constrain this surface — the endpoint requires admin auth on the calling org, so per-row outcomes don't leak across tenants.
Invitation_list GET
Next Page