USusekaneo
Projects

List projects

Changed on

List a workspace's projects in sidebar order, each with rollup task statistics. Archived projects are excluded unless includeArchived is set.

get/project

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/project
  • Auth
    HTTP bearer

Query parameters

workspaceIdstring required
includeArchivedstring

Pass "true" to include archived projects in the list.

Response

List of projects

idstring required
workspaceIdstring required
backgroundVersionstring nullable required
slugstring required

Short prefix used in task identifiers, e.g. KAN-12.

iconstring nullable required
namestring required
descriptionstring nullable required
createdAtstring date-time required
isPublicboolean nullable required

When true the project's board is readable without signing in, via /api/public-project/{id}.

archivedAtstring date-time nullable required

Non-null once archived; archived projects are hidden by default.

positionnumber required

Sidebar order, ascending.

lastTaskNumbernumber required

Highest task number issued in this project; the next task gets this plus one.

Changes

  • a29fbb97c906Revision changes
    • breaking

      the //// response's property type changed from object null to no type for status

    • breaking

      the ////// response's property type changed from object null to no type for status

    • breaking

      the //// response's property type changed from object null to no type for status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

    • info

      added subschema #2 to the ////// response property anyOf list for the response status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

  • d1d37e98039bRevision changes
    • info

      added the required property //// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property //// to the response with the status