Skip to content

Project

A Project is a body of work toward a Goal: its Tasks and Issues, a start, and a target date.

Properties

PropertyTypeRequiredDescription
startsOndateWhen work begins.
targetDatedateWhen it should be done.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/projects/project_1",
  "$type": "Project",
  "startsOn": "2026-10-22",
  "targetDate": "2026-10-22"
}

Relationships

  • A Project advances one Goal: a Project’s work serves one Goal. advances, inverse projects.
  • A Project plans many Tasks: a Project is made of Tasks. plans, inverse project.

Verbs

  1. createCreates a Project.
    POST /{namespace}/projectsdoProject.created
  2. getReturns one Project by id.
    GET /{namespace}/projects/{id}readNo Event
  3. listReturns Projects, newest first, one page at a time.
    GET /{namespace}/projectsreadNo Event
  4. updateChanges the given properties of a Project.
    PATCH /{namespace}/projects/{id}doProject.updated
  5. deleteDeletes a Project; its history is kept.
    DELETE /{namespace}/projects/{id}doProject.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Project.createYesYesYesNo
Project.getYesYesYesYes
Project.listYesYesYesYes
Project.updateYesYesYesNo
Project.deleteYesYesYesNo

Call it

Text
Add a project to RouteWise.

Example

A tax-preparation service opens a second state as a Project. It holds 22 Tasks and 4 Issues, starts on the 1st, and targets a date eight weeks later.