You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/openapi/openapi.yaml
+128Lines changed: 128 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -5750,6 +5750,25 @@ paths:
5750
5750
required: false
5751
5751
schema:
5752
5752
type: integer
5753
+
- description: |
5754
+
Filter members by organization role. Accepts single role or comma-separated list of roles.
5755
+
5756
+
**Format:**
5757
+
- Single role: `?role=RE`
5758
+
- Multiple roles: `?role=AN,RE` (users with ANY of these roles)
5759
+
5760
+
**Role Codes:**
5761
+
- `OW` = Owner
5762
+
- `AD` = Administrator
5763
+
- `MA` = Manager
5764
+
- `RE` = Reviewer
5765
+
- `AN` = Annotator
5766
+
- `NO` = Not Activated
5767
+
- `DI` = Disabled
5768
+
in: query
5769
+
name: role
5770
+
schema:
5771
+
type: string
5753
5772
- description: A search term.
5754
5773
in: query
5755
5774
name: search
@@ -7057,6 +7076,11 @@ paths:
7057
7076
name: search
7058
7077
schema:
7059
7078
type: string
7079
+
- description: Filter current_state by exact match
7080
+
in: query
7081
+
name: state
7082
+
schema:
7083
+
type: string
7060
7084
- description: Filter title by contains (case-insensitive)
7061
7085
in: query
7062
7086
name: title
@@ -7160,6 +7184,11 @@ paths:
7160
7184
name: search
7161
7185
schema:
7162
7186
type: string
7187
+
- description: Filter current_state by exact match
7188
+
in: query
7189
+
name: state
7190
+
schema:
7191
+
type: string
7163
7192
- description: Filter title by contains (case-insensitive)
7164
7193
in: query
7165
7194
name: title
@@ -8490,6 +8519,16 @@ paths:
8490
8519
required: true
8491
8520
schema:
8492
8521
type: integer
8522
+
- description: Filter by last activity (ISO 8601 formatted date). Only when all=True.
8523
+
in: query
8524
+
name: last_activity__gte
8525
+
schema:
8526
+
type: string
8527
+
- description: Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)
8528
+
in: query
8529
+
name: role
8530
+
schema:
8531
+
type: string
8493
8532
- description: Search term for filtering members by name, email, or username. Only when all=True.
8494
8533
in: query
8495
8534
name: search
@@ -8533,6 +8572,16 @@ paths:
8533
8572
required: true
8534
8573
schema:
8535
8574
type: integer
8575
+
- description: Filter by last activity (ISO 8601 formatted date). Only when all=True.
8576
+
in: query
8577
+
name: last_activity__gte
8578
+
schema:
8579
+
type: string
8580
+
- description: Filter by role, project roles take precedence over organization roles. Only when all=True. (comma-separated values)
8581
+
in: query
8582
+
name: role
8583
+
schema:
8584
+
type: string
8536
8585
- description: Search term for filtering members by name, email, or username. Only when all=True.
8537
8586
in: query
8538
8587
name: search
@@ -8582,6 +8631,14 @@ paths:
8582
8631
</p>
8583
8632
</Card>
8584
8633
Retrieve the members for a specific project.
8634
+
8635
+
**Response Fields:**
8636
+
- `implicit_member` (boolean): Indicates if the user is an implicit member.
8637
+
- `true`: User has access via workspace membership or organization role (Administrator/Owner)
8638
+
- `false`: User is an explicit project member (added directly to the project)
8639
+
- `project_role` (string|null): Project-specific role override if assigned, null otherwise
8640
+
8641
+
**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.
8585
8642
operationId: api_projects_members_paginated_list
8586
8643
parameters:
8587
8644
- in: path
@@ -8599,11 +8656,30 @@ paths:
8599
8656
name: implicit
8600
8657
schema:
8601
8658
type: boolean
8659
+
- description: Filter by last activity time (ISO 8601 datetime). Returns users with last activity greater than or equal to this time.
8660
+
in: query
8661
+
name: last_activity__gte
8662
+
schema:
8663
+
format: date-time
8664
+
type: string
8602
8665
- description: Exclude annotators from the results
8603
8666
in: query
8604
8667
name: no_annotators
8605
8668
schema:
8606
8669
type: boolean
8670
+
- description: |-
8671
+
Ordering field. Prefix with "-" for descending order. Allowed fields: id, email, first_name, last_name, username, last_activity, role, date_joined
8672
+
8673
+
**Note on role ordering:**
8674
+
When ordering by "role", the system uses the effective role:
8675
+
- Project-specific role if assigned (takes precedence)
8676
+
- Organization role if no project role is assigned
8677
+
8678
+
Roles are sorted alphabetically by their code: AD (Administrator), AN (Annotator), DI (Disabled), MA (Manager), NO (Not Activated), OW (Owner), RE (Reviewer)
8679
+
in: query
8680
+
name: ordering
8681
+
schema:
8682
+
type: string
8607
8683
- description: A page number within the paginated result set.
8608
8684
in: query
8609
8685
name: page
@@ -8616,6 +8692,30 @@ paths:
8616
8692
required: false
8617
8693
schema:
8618
8694
type: integer
8695
+
- description: |-
8696
+
Filter members by role. Accepts single role or comma-separated list of roles.
8697
+
8698
+
**Format:**
8699
+
- Single role: `?role=RE`
8700
+
- Multiple roles: `?role=AN,RE` (users with ANY of these roles)
8701
+
8702
+
**Role Codes:**
8703
+
- `OW` = Owner
8704
+
- `AD` = Administrator
8705
+
- `MA` = Manager
8706
+
- `RE` = Reviewer
8707
+
- `AN` = Annotator
8708
+
8709
+
**Matching Logic:**
8710
+
Returns users who have any of the specified roles either:
8711
+
1. As their **project-specific role** (from project role assignments), OR
8712
+
2. As their **organization role** (if they have no project-specific role override)
8713
+
8714
+
**Note:** Project-specific roles take precedence. If a user has a project role assigned, their organization role is ignored for filtering purposes.
8715
+
in: query
8716
+
name: role
8717
+
schema:
8718
+
type: string
8619
8719
- description: Search term for filtering members by name, email, or username
8620
8720
in: query
8621
8721
name: search
@@ -19453,6 +19553,9 @@ components:
19453
19553
description: Start model training after any annotations are submitted or updated
19454
19554
readOnly: true
19455
19555
type: boolean
19556
+
state:
19557
+
readOnly: true
19558
+
type: string
19456
19559
task_number:
19457
19560
description: Total task number in project
19458
19561
readOnly: true
@@ -19507,6 +19610,7 @@ components:
19507
19610
- reviewer_queue_total
19508
19611
- skipped_annotations_number
19509
19612
- start_training_on_annotation_update
19613
+
- state
19510
19614
- task_number
19511
19615
- total_annotations_number
19512
19616
- total_predictions_number
@@ -24505,6 +24609,9 @@ components:
24505
24609
description: Start model training after any annotations are submitted or updated
24506
24610
readOnly: true
24507
24611
type: boolean
24612
+
state:
24613
+
readOnly: true
24614
+
type: string
24508
24615
task_data_login:
24509
24616
description: 'Task data credentials: login'
24510
24617
maxLength: 256
@@ -24564,6 +24671,7 @@ components:
24564
24671
- reviewer_queue_total
24565
24672
- skipped_annotations_number
24566
24673
- start_training_on_annotation_update
24674
+
- state
24567
24675
- task_number
24568
24676
- total_annotations_number
24569
24677
- total_predictions_number
@@ -24785,6 +24893,9 @@ components:
24785
24893
description: Start model training after any annotations are submitted or updated
24786
24894
readOnly: true
24787
24895
type: boolean
24896
+
state:
24897
+
readOnly: true
24898
+
type: string
24788
24899
task_data_login:
24789
24900
description: 'Task data credentials: login'
24790
24901
maxLength: 256
@@ -24832,6 +24943,7 @@ components:
24832
24943
- queue_total
24833
24944
- skipped_annotations_number
24834
24945
- start_training_on_annotation_update
24946
+
- state
24835
24947
- task_number
24836
24948
- total_annotations_number
24837
24949
- total_predictions_number
@@ -25204,6 +25316,9 @@ components:
25204
25316
description: Start model training after any annotations are submitted or updated
25205
25317
readOnly: true
25206
25318
type: boolean
25319
+
state:
25320
+
readOnly: true
25321
+
type: string
25207
25322
task_data_login:
25208
25323
description: 'Task data credentials: login'
25209
25324
maxLength: 256
@@ -25267,6 +25382,7 @@ components:
25267
25382
- reviewer_queue_total
25268
25383
- skipped_annotations_number
25269
25384
- start_training_on_annotation_update
25385
+
- state
25270
25386
- task_number
25271
25387
- total_annotations_number
25272
25388
- total_predictions_number
@@ -25474,6 +25590,9 @@ components:
25474
25590
description: Start model training after any annotations are submitted or updated
25475
25591
readOnly: true
25476
25592
type: boolean
25593
+
state:
25594
+
readOnly: true
25595
+
type: string
25477
25596
task_data_login:
25478
25597
description: 'Task data credentials: login'
25479
25598
maxLength: 256
@@ -25527,6 +25646,7 @@ components:
25527
25646
- review_settings
25528
25647
- skipped_annotations_number
25529
25648
- start_training_on_annotation_update
25649
+
- state
25530
25650
- task_number
25531
25651
- total_annotations_number
25532
25652
- total_predictions_number
@@ -28031,6 +28151,9 @@ components:
28031
28151
id:
28032
28152
readOnly: true
28033
28153
type: integer
28154
+
implicit_member:
28155
+
readOnly: true
28156
+
type: boolean
28034
28157
initials:
28035
28158
default: '?'
28036
28159
readOnly: true
@@ -28072,6 +28195,7 @@ components:
28072
28195
- active_organization_meta
28073
28196
- avatar
28074
28197
- id
28198
+
- implicit_member
28075
28199
- initials
28076
28200
- last_activity
28077
28201
- lse_fields
@@ -30370,6 +30494,9 @@ components:
30370
30494
description: Start model training after any annotations are submitted or updated
0 commit comments