Invite someone to the workspace by email
Creates a pending invite at the requested role, queues the invitation email, and returns the invite together with its one-time token; re-inviting an address that already has a pending invite refreshes that invite and rotates its token instead of creating a second one. Requires `members:invite`, and only owners may invite owners. Fails when the email already belongs to a member, when the address or expiry is malformed, and when an editor-role invite would exceed the plan's seat allowance — viewer invites do not consume a seat.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/invites" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "role": "owner" }'{ "data": { "id": "string", "workspaceId": "string", "email": "string", "role": "owner", "status": "pending", "token": "string", "expiresAt": "string", "createdAt": "string", "updatedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}List the workspace's invites
Returns every invite created for the workspace, newest first, including ones that have already been accepted, revoked, or expired. Requires `members:invite`, held by owners and admins.
List the caller's pending workspace invitations
Returns the pending invites addressed to the authenticated caller's email across all active workspaces, which is the invite inbox shown during onboarding. Account-scoped rather than workspace-scoped and requires a synced user profile; a caller whose identity carries no email gets an empty list.