client.projects

Projects group studies within your organization.

list()

client.projects.list() -> ProjectListOut

List every project in your organization. Returns ProjectListOut, with projects holding a list of ProjectOut.

for project in client.projects.list().projects:
    print(project.id, project.name, project.study_count)

client.projects.create(*, name: str, description: str | None = None) -> ProjectOut

str

required

Project name.

str

Project description.

Returns ProjectOut.

client.projects.get(project_id) -> ProjectOut

str | UUID

required

The project.

Returns ProjectOut. Raises NotFoundError if it doesn’t exist.

client.projects.update(project_id, *, name: str | None = None, description: str | None = None) -> ProjectOut

Update a project’s name and/or description. Fields you omit are left as they are.

str | UUID

required

The project.

str

New name.

str

New description.

Returns ProjectOut.