# This file was auto-generated by Fern from our API Definition.
import datetime as dt
import typing
from json.decoder import JSONDecodeError
from ....core.api_error import ApiError
from ....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ....core.datetime_utils import serialize_datetime
from ....core.jsonable_encoder import jsonable_encoder
from ....core.pagination import AsyncPager, SyncPager
from ....core.request_options import RequestOptions
from ....core.unchecked_base_model import construct_type
from ....types.paginated_paginated_project_member_list import PaginatedPaginatedProjectMemberList
from ....types.paginated_project_member import PaginatedProjectMember
class RawPaginatedClient:
def __init__(self, *, client_wrapper: SyncClientWrapper):
self._client_wrapper = client_wrapper
def list(
self,
id: int,
*,
ids: typing.Optional[str] = None,
implicit: typing.Optional[bool] = None,
last_activity_gte: typing.Optional[dt.datetime] = None,
last_activity_lte: typing.Optional[dt.datetime] = None,
no_annotators: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
page: typing.Optional[int] = None,
page_size: typing.Optional[int] = None,
role: typing.Optional[str] = None,
search: typing.Optional[str] = None,
tags: typing.Optional[str] = None,
with_deleted: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> SyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific project.
**Response Fields:**
- `implicit_member` (boolean): Indicates if the user is an implicit member.
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
- `false`: User is an explicit project member (added directly to the project)
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
**Note:** Users can have both explicit membership AND implicit access. The `implicit_member` field is `false` if the user has an explicit ProjectMember entry, regardless of whether they also have implicit access via workspace or org role.
Parameters
----------
id : int
ids : typing.Optional[str]
Comma-separated list of user IDs to filter by
implicit : typing.Optional[bool]
Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned.
last_activity_gte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
last_activity_lte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time.
no_annotators : typing.Optional[bool]
Exclude annotators from the results
ordering : typing.Optional[str]
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
**Note on role ordering:**
When ordering by "role", the system uses the effective role:
- Project-specific role if assigned (takes precedence)
- Organization role if no project role is assigned
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
role : typing.Optional[str]
Filter members by 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
**Matching Logic:**
Returns users who have any of the specified roles either:
1. As their **project-specific role** (from project role assignments), OR
2. As their **organization role** (if they have no project-specific role override)
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
search : typing.Optional[str]
Search term for filtering members by name, email, or username
tags : typing.Optional[str]
Filter members by tags. Use a comma-separated list of tag IDs.
with_deleted : typing.Optional[bool]
Include deleted members in the results
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
SyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]
"""
page = page if page is not None else 1
_response = self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/members/paginated/",
method="GET",
params={
"ids": ids,
"implicit": implicit,
"last_activity__gte": serialize_datetime(last_activity_gte) if last_activity_gte is not None else None,
"last_activity__lte": serialize_datetime(last_activity_lte) if last_activity_lte is not None else None,
"no_annotators": no_annotators,
"ordering": ordering,
"page": page,
"page_size": page_size,
"role": role,
"search": search,
"tags": tags,
"with_deleted": with_deleted,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_parsed_response = typing.cast(
PaginatedPaginatedProjectMemberList,
construct_type(
type_=PaginatedPaginatedProjectMemberList, # type: ignore
object_=_response.json(),
),
)
_items = _parsed_response.results
_has_next = True
_get_next = lambda: self.list(
id,
ids=ids,
implicit=implicit,
last_activity_gte=last_activity_gte,
last_activity_lte=last_activity_lte,
no_annotators=no_annotators,
ordering=ordering,
page=page + 1,
page_size=page_size,
role=role,
search=search,
tags=tags,
with_deleted=with_deleted,
request_options=request_options,
)
return SyncPager(has_next=_has_next, items=_items, get_next=_get_next, response=_parsed_response)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
class AsyncRawPaginatedClient:
def __init__(self, *, client_wrapper: AsyncClientWrapper):
self._client_wrapper = client_wrapper
async def list(
self,
id: int,
*,
ids: typing.Optional[str] = None,
implicit: typing.Optional[bool] = None,
last_activity_gte: typing.Optional[dt.datetime] = None,
last_activity_lte: typing.Optional[dt.datetime] = None,
no_annotators: typing.Optional[bool] = None,
ordering: typing.Optional[str] = None,
page: typing.Optional[int] = None,
page_size: typing.Optional[int] = None,
role: typing.Optional[str] = None,
search: typing.Optional[str] = None,
tags: typing.Optional[str] = None,
with_deleted: typing.Optional[bool] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]:
"""
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
Retrieve the members for a specific project.
**Response Fields:**
- `implicit_member` (boolean): Indicates if the user is an implicit member.
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
- `false`: User is an explicit project member (added directly to the project)
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
**Note:** Users can have both explicit membership AND implicit access. The `implicit_member` field is `false` if the user has an explicit ProjectMember entry, regardless of whether they also have implicit access via workspace or org role.
Parameters
----------
id : int
ids : typing.Optional[str]
Comma-separated list of user IDs to filter by
implicit : typing.Optional[bool]
Include/Exclude implicit project members in the results. If not provided, explicit + implicit members are returned.
last_activity_gte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
last_activity_lte : typing.Optional[dt.datetime]
Filter by last activity time (ISO 8601 datetime). Returns users with last activity less than or equal to this time.
no_annotators : typing.Optional[bool]
Exclude annotators from the results
ordering : typing.Optional[str]
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
**Note on role ordering:**
When ordering by "role", the system uses the effective role:
- Project-specific role if assigned (takes precedence)
- Organization role if no project role is assigned
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
page : typing.Optional[int]
A page number within the paginated result set.
page_size : typing.Optional[int]
Number of results to return per page.
role : typing.Optional[str]
Filter members by 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
**Matching Logic:**
Returns users who have any of the specified roles either:
1. As their **project-specific role** (from project role assignments), OR
2. As their **organization role** (if they have no project-specific role override)
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
search : typing.Optional[str]
Search term for filtering members by name, email, or username
tags : typing.Optional[str]
Filter members by tags. Use a comma-separated list of tag IDs.
with_deleted : typing.Optional[bool]
Include deleted members in the results
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
AsyncPager[PaginatedProjectMember, PaginatedPaginatedProjectMemberList]
"""
page = page if page is not None else 1
_response = await self._client_wrapper.httpx_client.request(
f"api/projects/{jsonable_encoder(id)}/members/paginated/",
method="GET",
params={
"ids": ids,
"implicit": implicit,
"last_activity__gte": serialize_datetime(last_activity_gte) if last_activity_gte is not None else None,
"last_activity__lte": serialize_datetime(last_activity_lte) if last_activity_lte is not None else None,
"no_annotators": no_annotators,
"ordering": ordering,
"page": page,
"page_size": page_size,
"role": role,
"search": search,
"tags": tags,
"with_deleted": with_deleted,
},
request_options=request_options,
)
try:
if 200 <= _response.status_code < 300:
_parsed_response = typing.cast(
PaginatedPaginatedProjectMemberList,
construct_type(
type_=PaginatedPaginatedProjectMemberList, # type: ignore
object_=_response.json(),
),
)
_items = _parsed_response.results
_has_next = True
async def _get_next():
return await self.list(
id,
ids=ids,
implicit=implicit,
last_activity_gte=last_activity_gte,
last_activity_lte=last_activity_lte,
no_annotators=no_annotators,
ordering=ordering,
page=page + 1,
page_size=page_size,
role=role,
search=search,
tags=tags,
with_deleted=with_deleted,
request_options=request_options,
)
return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next, response=_parsed_response)
_response_json = _response.json()
except JSONDecodeError:
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)