Projects

Create project

Create a project in a workspace. The slug becomes the prefix of its task identifiers.

post/project

Request body

namestring required
workspaceIdstring required
iconstring required
slugstring required

Response

The created project

idstring required
workspaceIdstring 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

Changed in 6 of the 23 revisions of this API.1320

  • 08bbb5bedb5d15See the full diff
    • the archivedAt response's property type/format changed from / to string null/date-time for status 200

      response-property-type-changed

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the required property lastTaskNumber to the response with the 200 status

      response-required-property-added

    • added the required property position to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 32cece1ebe4321See the full diff
    • request body became required

      request-body-became-required

    • the createdAt response's property type/format changed from / to string/date-time for status 200

      response-property-type-changed

    • added the required property archivedAt to the response with the 200 status

      response-required-property-added

    • the response property description became nullable for the status 200

      response-property-became-nullable

    • the response property icon became nullable for the status 200

      response-property-became-nullable

    • the response property isPublic became nullable for the status 200

      response-property-became-nullable

    • response property description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property icon list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property isPublic list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property description list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property icon list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • response property isPublic list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b8811b821e633See the full diff
    • the response property description became nullable for the status 200

      response-property-became-nullable

    • the response property icon became nullable for the status 200

      response-property-became-nullable

    • the response property isPublic became nullable for the status 200

      response-property-became-nullable

    • response property description list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property icon list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • response property isPublic list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

  • 93b23177312618See the full diff
    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • added the required property createdAt to the response with the 200 status

      response-required-property-added

    • added the required property description to the response with the 200 status

      response-required-property-added

    • added the required property icon to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property isPublic to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property slug to the response with the 200 status

      response-required-property-added

    • added the required property workspaceId to the response with the 200 status

      response-required-property-added