✨ Get configurable permissions options | API Reference

curl http://localhost:8000/api/organizations/1/permissions/options \
     -H "Authorization: <apiKey>"

[
  {
    "default": [
      "MA"
    ],
    "options": [
      "OW",
      "AD",
      "MA"
    ],
    "permission": "edit_projects",
    "group": "Project Management",
    "label": "Edit Projects",
    "tooltip": "Allows users to create, update, and delete projects within the organization."
  },
  {
    "default": [
      "RE"
    ],
    "options": [
      "OW",
      "AD",
      "MA",
      "RE"
    ],
    "permission": "review_annotations",
    "group": "Annotation",
    "label": "Review Annotations",
    "tooltip": "Grants permission to review and approve annotations made by annotators."
  },
  {
    "default": [
      "AN"
    ],
    "options": [
      "OW",
      "AD",
      "MA",
      "RE",
      "AN"
    ],
    "permission": "annotate_data",
    "group": "Annotation",
    "label": "Annotate Data",
    "tooltip": "Allows users to perform data annotation tasks."
  },
  {
    "default": [
      "AD"
    ],
    "options": [
      "OW",
      "AD"
    ],
    "permission": "manage_users",
    "group": "User Management",
    "label": "Manage Users",
    "tooltip": "Allows managing user roles and permissions within the organization."
  }
]

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles).

<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> Retrieve the list of configurable permission options (label, tooltip, default role and allowed roles).

Authentication

Authorizationstring

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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>

Path parameters

idintegerRequired

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Response

defaultlist of enums

optionslist of enums

permissionstring

groupstring or null

labelstring or null

tooltipstring or null