API ReferenceOrganizationsInvites

✨ Send email with invite

<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Send email with invite to organization

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Request

This endpoint expects an object.
emailslist of stringsRequired
Email addresses
projectslist of integersOptional
Project IDs to grant access to
roleenum or nullOptional

Organization role. Required unless user_type is viewonly.

  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
user_typeenumOptionalDefaults to standard

Seat type for the invited members. View-Only members are free read-only seats scoped to the invited projects/workspaces and cannot be combined with a role. Flex members keep a normal working role and consume Flex capacity in assigned claim mode.

  • standard - Standard
  • flex - Flex
  • viewonly - View Only
workspaceslist of integersOptional
Workspace IDs to grant access to

Response

Invite sent

Errors

403
Forbidden Error