Skip to content

fix list_users docs #774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

fix list_users docs #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/superannotate/lib/app/interface/sdk_interface.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,15 +511,15 @@ def list_users(
Scores and Custom Field Filtering:

- Scores and other custom fields must be prefixed with `custom_field__` .
- Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due date is after the given Unix timestamp).
- Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due_date is after the given Unix timestamp).

- **Text** custom field only works with the following filter params: __in, __notin, __contains
- **Numeric** custom field only works with the following filter params: __in, __notin, __ne, __gt, __gte, __lt, __lte
- **Single-select** custom field only works with the following filter params: __in, __notin, __contains
- **Multi-select** custom field only works with the following filter params: __in, __notin
- **Date picker** custom field only works with the following filter params: __gt, __gte, __lt, __lte

**If score name has a space, please use the following format to filter them**:
**If custom field has a space, please use the following format to filter them**:
::

user_filters = {"custom_field__accuracy score 30D__lt": 90}
Expand Down Expand Up @@ -3821,7 +3821,7 @@ def list_projects(

Custom Fields Filtering:
- Custom fields must be prefixed with `custom_field__`.
- Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due date is after the given Unix timestamp).
- Example: custom_field__Due_date__gte="1738281600" (filtering users whose Due_date is after the given Unix timestamp).
- If include does not include "custom_fields" but filter contains custom_fields, an error will be returned

:type filters: ProjectFilters, optional
Expand Down