team
team

Invite User

Send user invitation (owner/admin only).

Creates an invitation and sends an email to the specified address. The invited user will receive a link to join the company.

post/api/v1/team/invitations

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/team/invitations
  • Auth: none declared

Headers

Authorizationstring

Request body

emailstring email required

Email address of the user to invite

role'owner' | 'admin' | 'member' | 'viewer'

Company roles for team management.

Validated at API layer via Pydantic, stored as VARCHAR in DB.

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.