✨ Get organization members/roles

GET

http://localhost:8000/api/organizations/:id/memberships

GET

/api/organizations/:id/memberships

$ curl http://localhost:8000/api/organizations/1/memberships \
>      -H "Authorization: Token  <api_key>"

200Retrieved

1 {
2   "count": 123,
3   "results": [
4     {
5       "concurrency": {},
6       "contributed_to_projects": [
7         {
8           "id": 1,
9           "title": "string"
10         }
11       ],
12       "created_projects": [
13         {
14           "id": 1,
15           "title": "string"
16         }
17       ],
18       "id": 1,
19       "organization": 1,
20       "role": "string",
21       "role_source": "string",
22       "tags": [
23         {
24           "id": 1,
25           "label": "string"
26         }
27       ],
28       "user": {
29         "avatar": "string",
30         "id": 1,
31         "initials": "?",
32         "last_activity": "2024-01-15T09:30:00Z",
33         "lse_fields": {
34           "email_notification_settings": {},
35           "invite_expired": true,
36           "invite_expired_at": "2024-01-15T09:30:00Z",
37           "invite_activated": true,
38           "invited_at": "2024-01-15T09:30:00Z",
39           "invited_by": 1,
40           "onboarding_state": "not_started",
41           "social_auth_finished": true,
42           "trial_company": "string",
43           "trial_experience_labeling": "string",
44           "trial_license_enterprise": true,
45           "trial_models_in_production": "string",
46           "trial_role": "annotator"
47         },
48         "pause": {},
49         "username": "string",
50         "contributed_to_projects": [
51           {
52             "id": 1,
53             "title": "string"
54           }
55         ],
56         "created_projects": [
57           {
58             "id": 1,
59             "title": "string"
60           }
61         ],
62         "active_organization": 1,
63         "allow_newsletters": true,
64         "custom_hotkeys": null,
65         "date_joined": "2024-01-15T09:30:00Z",
66         "email": "string",
67         "first_name": "string",
68         "last_name": "string",
69         "phone": "string"
70       },
71       "user_type": "string"
72     }
73   ],
74   "next": "http://api.example.org/accounts/?page=4",
75   "previous": "http://api.example.org/accounts/?page=2"
76 }

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).

is_deletedbooleanOptional

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

scopeenumOptional

Member visibility scope. accessible (default) limits Managers to members in their projects/workspaces. all returns all organization members. Only affects Manager role.

Allowed values:

searchstringOptional

A search term.

tagsstringOptional

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

user__last_activity__gtedatetimeOptional

user__last_activity__ltedatetimeOptional

user_typelist of stringsOptional

Multiple values may be separated by commas.

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"