✨ Get organization members/roles | API Reference

curl http://localhost:8000/api/organizations/1/memberships \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "count": 3,
  "results": [
    {
      "concurrency": "v1",
      "contributed_to_projects": [
        {
          "id": 101,
          "title": "Image Annotation Project"
        },
        {
          "id": 102,
          "title": "Text Classification"
        }
      ],
      "created_projects": [
        {
          "id": 100,
          "title": "Object Detection Dataset"
        }
      ],
      "id": 15,
      "organization": 1,
      "role": "AD",
      "tags": [
        {
          "id": 5,
          "label": "Team Lead"
        },
        {
          "id": 7,
          "label": "Remote"
        }
      ],
      "user": {
        "avatar": "https://example.com/avatars/user15.png",
        "id": 15,
        "initials": "AJ",
        "last_activity": "2024-04-10T16:20:00Z",
        "lse_fields": {
          "email_notification_settings": "daily_summary",
          "invite_expired": "false",
          "invite_expired_at": "2024-12-31T23:59:59Z",
          "invite_activated": true,
          "invited_at": "2023-11-15T10:00:00Z",
          "invited_by": 2,
          "onboarding_state": "complete",
          "social_auth_finished": true,
          "trial_company": "Tech Innovators Inc.",
          "trial_experience_labeling": "3 years of experience in image labeling",
          "trial_license_enterprise": true,
          "trial_models_in_production": "Object detection and NLP models",
          "trial_role": "business_analyst"
        },
        "pause": "none",
        "username": "alicej",
        "contributed_to_projects": [
          {
            "id": 101,
            "title": "Image Annotation Project"
          }
        ],
        "created_projects": [
          {
            "id": 100,
            "title": "Object Detection Dataset"
          }
        ],
        "active_organization": 1,
        "allow_newsletters": false,
        "date_joined": "2023-11-20T08:45:00Z",
        "email": "alice.jones@example.com",
        "first_name": "Alice",
        "last_name": "Jones",
        "phone": "+1-555-123-4567"
      }
    },
    {
      "concurrency": "v2",
      "contributed_to_projects": [
        {
          "id": 103,
          "title": "Sentiment Analysis"
        }
      ],
      "id": 16,
      "organization": 1,
      "role": "AN",
      "tags": [
        {
          "id": 8,
          "label": "Part-time"
        }
      ],
      "user": {
        "avatar": "https://example.com/avatars/user16.png",
        "id": 16,
        "initials": "BS",
        "last_activity": "2024-04-12T09:15:00Z",
        "lse_fields": {
          "email_notification_settings": "immediate",
          "invite_expired": "false",
          "invite_expired_at": "2025-01-01T00:00:00Z",
          "invite_activated": true,
          "invited_at": "2024-01-25T14:30:00Z",
          "invited_by": 15,
          "onboarding_state": "trial_signup",
          "social_auth_finished": false,
          "trial_company": "Data Insights LLC",
          "trial_experience_labeling": "New to labeling",
          "trial_license_enterprise": false,
          "trial_models_in_production": "",
          "trial_role": "annotator"
        },
        "pause": "none",
        "username": "bobsmith",
        "contributed_to_projects": [
          {
            "id": 103,
            "title": "Sentiment Analysis"
          }
        ],
        "active_organization": 1,
        "allow_newsletters": true,
        "date_joined": "2024-02-01T12:00:00Z",
        "email": "bob.smith@example.com",
        "first_name": "Bob",
        "last_name": "Smith",
        "phone": "+1-555-987-6543"
      }
    },
    {
      "concurrency": "v1",
      "created_projects": [
        {
          "id": 104,
          "title": "Video Annotation"
        }
      ],
      "id": 17,
      "organization": 1,
      "role": "MA",
      "tags": [
        {
          "id": 9,
          "label": "Full-time"
        }
      ],
      "user": {
        "avatar": "https://example.com/avatars/user17.png",
        "id": 17,
        "initials": "CW",
        "last_activity": "2024-04-11T14:00:00Z",
        "lse_fields": {
          "email_notification_settings": "weekly",
          "invite_expired": "false",
          "invite_expired_at": "2024-11-30T23:59:59Z",
          "invite_activated": true,
          "invited_at": "2023-10-05T09:00:00Z",
          "invited_by": 15,
          "onboarding_state": "in_app_guidance",
          "social_auth_finished": true,
          "trial_company": "Vision AI Corp",
          "trial_experience_labeling": "5 years in video annotation",
          "trial_license_enterprise": true,
          "trial_models_in_production": "Video object tracking",
          "trial_role": "annotator_team_manager"
        },
        "pause": "none",
        "username": "carolw",
        "created_projects": [
          {
            "id": 104,
            "title": "Video Annotation"
          }
        ],
        "active_organization": 1,
        "allow_newsletters": true,
        "date_joined": "2023-10-10T11:00:00Z",
        "email": "carol.white@example.com",
        "first_name": "Carol",
        "last_name": "White",
        "phone": "+1-555-321-7654"
      }
    }
  ],
  "next": "http://api.example.org/accounts/?page=2"
}

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

Retrieve a list of all users and roles in a specific organization.

<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 a list of all users and roles in a specific 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:

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

A unique integer value identifying this organization.

Query parameters

contributed_to_projectsbooleanOptional

Whether to include projects created and contributed to by the members.

exclude_project_idintegerOptional

Project ID to exclude users who are already associated with this project (direct members, workspace members, or implicit admin/owner access).

exclude_workspace_idintegerOptional

Workspace ID to exclude users who are already associated with this workspace (direct workspace members or implicit admin/owner access).

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

rolestringOptional

Filter members by organization role. Accepts single role or comma-separated list of roles.

Format:

Single role: ?role=RE
Multiple roles: ?role=AN,RE (users with ANY of these roles)

Role Codes:

OW = Owner
AD = Administrator
MA = Manager
RE = Reviewer
AN = Annotator
NO = Not Activated
DI = Disabled

Filter members by organization role. Accepts single role or comma-separated list of roles. **Format:** - Single role: `?role=RE` - Multiple roles: `?role=AN,RE` (users with ANY of these roles) **Role Codes:** - `OW` = Owner - `AD` = Administrator - `MA` = Manager - `RE` = Reviewer - `AN` = Annotator - `NO` = Not Activated - `DI` = Disabled

searchstringOptional

A search term.

tagsstringOptional

Filter members by tags. Use a comma-separated list of tag IDs.

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"