Query parameters

• subteam_id string

  Filter projects by subteam. Subteam ID in shortid format. Omit for all teams.

• archived string

  When "true", returns only archived projects. When "false", returns only active. Pass as query string.

  Values are true or false. Default value is false.

• limit string

  Maximum number of projects to return per page.

  Default value is 25.

• offset string

  Number of records to skip for pagination. Page 1 = 0, page 2 = limit, etc.

  Default value is 0.

• sort string

  Sort order: ascending or descending.

  Values are ascending or descending.

Responses

• 200 application/json

  Success Response

  Hide response attributes Show response attributes object

  • items array[object] Required

    List of projects matching the query. Each item uses shortid for id, owner, members, etc.

    Hide items attributes Show items attributes object

    • id string Required

      Project ID (shortid format, e.g. from shortid package).

    • nice_id string Required

      Short custom identifier for the project (2–5 characters). Used in task IDs and URLs.

    • name string Required

      Project name.

    • description string Required

      Project description or summary.

    • initials string Required

      Project initials (abbreviation).

    • logo string

      URL of the project logo image. Omitted if not set.

    • color string Required

      Primary hex color for the project.

    • secondary_color string Required

      Secondary hex color for the project.

    • demo boolean Required

      Whether this is a demo project.

    • archived boolean Required

      Whether the project is archived.

    • auto_milestones boolean Required

      Whether automatic milestones are enabled.

    • default_tasks_view string Required

      Default view for the Tasks section: table, calendar, swimlane, kanban, timeline, report.

    • access_type string Required

      Access type: public, limited, or personal.

    • owner string Required

      Project owner member ID (shortid).

    • members array[string] Required

      List of project member IDs (shortid), excluding owner.

    • general_discussion string Required

      General discussion thread ID (shortid).

    • subteam string Required

      Subteam ID (shortid) this project belongs to.

    • progress number Required

      Task completion progress (0–1). Completed tasks / total tasks.

    • joined boolean Required

      Whether the requesting member has joined the project.

    • general_discussion_muted boolean Required

      Whether general discussion is muted for the requesting member.

    • email string Required

      Project-specific email address for sending to discussion.

    • zoom_id string

      Zoom meeting ID when Zoom is linked.

    • zoom_password string

      Zoom meeting password when Zoom is linked.

    • zoom_join_url string

      Zoom join URL when Zoom is linked.

    • webex_id string

      Webex meeting ID when Webex is linked.

    • webex_password string

      Webex meeting password when Webex is linked.

    • webex_join_url string

      Webex join URL when Webex is linked.

    • enabled_modules array[string] Required

      Enabled project modules (e.g. milestones, tasks, docs).

    • disabled_modules array[string] Required

      Disabled project modules.

    • disabled_widgets number Required

      Widgets disabled on the project. See WidgetsType enum.

      Values are 0, 1, 2, 3, 4, 5, 6, 7, or 8.

    • hidden_taskboard_fields number Required

      Task board fields hidden from view. See TaskBoardFieldType enum.

      Values are 0, 1, 2, 3, or 4.

    • repo string | null Required

      Linked GitHub repo URL. Null if not linked.

    • total_story_points number Required

      Total story points across all tasks.

    • completed_story_points number Required

      Completed story points.

    • pinned_message string

      Pinned message content in general discussion.

    • pinned_by string

      Member ID (shortid) who pinned the message.

    • completion_groups array[string] Required

      Completion groups for task grouping.

    • doc_root_folder object Required

      Root folder reference for Documents section.

    • file_root_folder object Required

      Root folder reference for Files section.

    • removed boolean Required

      True if the project is scheduled for deletion (soft-deleted).

    • milestones_rollup object Required

      Rollup summary for milestones.

    • rollups array[object] Required

      Rollup summaries for various entities.
    • list_columns_order array[string] Required

      Order of list view columns.

    • hidden_list_columns array[string] Required

      List view columns hidden from display.

    • integrations array[object] Required

      Integrations connected to the project (e.g. Slack, GitHub).
  • hasMore boolean Required

    True if more records exist beyond the current page; use offset/limit to fetch next page.

• 401

  The client request has not been completed because it lacks valid authentication credentials for the requested resource.

• 403

  The client does not have access rights to the content.

• 405

  The request method is known by the server but is not supported by the target resource.