find_projects
toloka.client.TolokaClient.find_projects | Source code
Finds projects that match certain criteria.
The number of returned projects is limited. To find remaining projects call find_projects with updated search criteria.
To iterate over all matching projects you may use the get_projects method.
Parameters Description
| Parameters | Type | Description |
|---|---|---|
status |
Optional[Project.ProjectStatus] | Project status. Refer to the ProjectStatus page for more information on the available |
id_lt |
Optional[str] | Projects with IDs less than the specified value. |
id_lte |
Optional[str] | Projects with IDs less than or equal to the specified value. |
id_gt |
Optional[str] | Projects with IDs greater than the specified value. |
id_gte |
Optional[str] | Projects with IDs greater than or equal to the specified value. |
created_lt |
Optional[datetime] | Projects created before the specified date. |
created_lte |
Optional[datetime] | Projects created before or on the specified date. |
created_gt |
Optional[datetime] | Projects created after the specified date. |
created_gte |
Optional[datetime] | Projects created after or on the specified date. |
sort |
Union[List[str], ProjectSortItems, None] | Sorting options. Default: |
limit |
Optional[int] | Returned projects limit. The default limit is 20. The maximum allowed limit is 300. |
-
Returns:
Found projects and a flag showing whether there are more matching projects exceeding the limit.
-
Return type:
Examples:
The example shows how to find projects created before a specific date.
projects = toloka_client.find_projects(created_lt='2021-06-01T00:00:00')
If there are projects exceeding the limit, then projects.has_more is set to True.