Skip to content

Projects

toggl_api.modules.project.ProjectBody dataclass

JSON body dataclass for PUT, POST & PATCH requests.

format_body(workspace_id: int) -> dict[str, Any]

Formats the body for JSON requests.

Gets called by the endpoint methods before requesting.

Parameters:

  • workspace_id (int) –

    Alternate Workspace ID for the request if the body does not contain a workspace_id.

Returns:

  • dict[str, Any]

    dict[str, Any]: JSON compatible formatted body.

toggl_api.modules.project.ProjectEndpoint

Bases: TogglCachedEndpoint

get_projects(*, refresh: bool = False) -> Optional[list[TogglProject]]

delete_project(project: TogglProject | int) -> None

edit_project(project: TogglProject | int, body: ProjectBody) -> Optional[TogglProject]

add_project(body: ProjectBody) -> Optional[TogglProject]