Skip to content

client.projects

client.projects — the projects operations.

On AsyncKindgi every method is the same, awaited.

get_default(*, timeout: float | None = None) -> Project

Fetch the tenant's Default project. GET /v1/projects/default

Returns the row where Project.isDefault = true (exactly one per tenant). Returns 404 project-not-found when no Default has been provisioned.

list(
*,
limit: int | None = None,
cursor: str | None = None,
org_id: str | None = None,
name_contains: str | None = None,
timeout: float | None = None,
) -> ProjectCollectionPage

List projects in the caller's tenant. GET /v1/projects

Cursor-paginated. Optional ?orgId= narrows to a specific org (projects may have no org; absent = all); ?nameContains= substring-matches on Project.name.

create(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> CreateResourceResult

Create a project. POST /v1/projects

get(*, timeout: float | None = None) -> Project

Fetch a project by id. GET /v1/projects/{projectId}

update(
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> None

Partially update a project. PATCH /v1/projects/{projectId}

delete(*, idempotency_key: str | None = None, timeout: float | None = None) -> None

Delete a project (idempotent). DELETE /v1/projects/{projectId}