get_app_projects

toloka.client.TolokaClient.get_app_projects | Source code

Finds all App projects that match certain criteria.

get_app_projects returns a generator. You can iterate over all found projects using the generator. Several requests to the Toloka server are possible while iterating.

If you need to sort App projects use the find_app_projects method.

Parameters description

ParametersTypeDescription
app_idOptional[str]

Projects created using the solution with the specified ID.

parent_app_project_idOptional[str]

Projects cloned from the project with the specified ID. Projects can be cloned in the web version of Toloka.

statusOptional[AppProject.Status]

App project status. Refer to the AppProject.Status page for more information on the available status values.

after_idOptional[str]

The ID of a project used for cursor pagination.

scopeOptional[AppProjectSearchRequest.Scope]

Values:

  • 'MY' — Projects created by you.
  • 'COMPANY' — Projects created by requesters from your company.
  • 'REQUESTER_LIST' — Projects created by requesters in the requester_ids list.
requester_idsUnion[str, List[str], None]

A list with requester IDs separated by a comma. Use the list with parameter scope = REQUESTER_LIST.

id_gtOptional[str]

Projects with IDs greater than the specified value.

id_gteOptional[str]

Projects with IDs greater than or equal to the specified value.

id_ltOptional[str]

Projects with IDs less than the specified value.

id_lteOptional[str]

Projects with IDs less than or equal to the specified value.

name_gtOptional[str]

Projects with a name lexicographically greater than the specified value.

name_gteOptional[str]

Projects with a name lexicographically greater than or equal to the specified value.

name_ltOptional[str]

Projects with a name lexicographically less than the specified value.

name_lteOptional[str]

Projects with a name lexicographically less than or equal to the specified value.

created_gtOptional[datetime]

Projects created after the specified date.

created_gteOptional[datetime]

Projects created after or on the specified date.

created_ltOptional[datetime]

Projects created before the specified date.

created_lteOptional[datetime]

Projects created before or on the specified date.

batch_sizeOptional[int]

A limit of items returned by each request to Toloka. The maximum allowed value: 5000.

  • Yields:

    The next matching App project.

  • Yield type:

    Generator[AppProject, None, None]

Examples:

app_projects = toloka_client.get_app_projects(scope='MY')
for app_project in app_projects:
print(app_project.id, app_project.status, app_project.name)

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming