Skip to main content

Projects

Complete reference for project-related methods.

Methods​

get_projects​

get_projects() -> ProjectsResponse

Get all projects in current space.

Returns: ProjectsResponse with list of projects

get_project​

get_project(project_id: str) -> ProjectResponse

Get a single project by ID.

Parameters:

  • project_id - Project ID

Returns: ProjectResponse with project data

Models​

Project​

Main project model representing a project in the system.

class Project:
    id: str                      # Project ID
    name: str                    # Project name
    slug: Optional[str]          # URL-friendly slug
    color: Optional[str]         # Color enum value
    icon: Optional[Icon]         # Icon enum value
    description: Optional[str]   # Project description
    team: List[str]              # Team member IDs
    space: Optional[str]         # Space ID
    creator: str                 # Creator ID
    archiver: Optional[str]      # Archiver ID (if archived)
    archived_at: Optional[datetime]  # Archive timestamp
    created_at: datetime         # Creation timestamp
    updated_at: datetime         # Last update timestamp

Response Models​

ProjectResponse​

class ProjectResponse:
    type: str                    # Response type ("GetProject")
    payload: ProjectPayload      # Response payload
    
    @property
    def project(self) -> Project:  # Convenience property
        ...

ProjectPayload​

class ProjectPayload:
    project: Project             # Project object

ProjectsResponse​

class ProjectsResponse:
    type: str                    # Response type ("GetProjects")
    payload: ProjectsPayload     # Response payload
    
    @property
    def projects(self) -> List[Project]:  # Convenience property
        ...

ProjectsPayload​

class ProjectsPayload:
    projects: List[Project]      # List of projects

See Also​