Skip to main content

The Project

A project is a unit of work with its own deadlines, assignments, and priority — distinct from a case. Where a case is a legal matter, a project is any tracked piece of work (an audit, an investigation, a research effort) that a team runs.

How you address it

/entitymanagement/v1/projects # list, create
/entitymanagement/v1/projects/{project} # retrieve, update, delete
/entitymanagement/v1/projects/overdue # projects past deadline
/entitymanagement/v1/projects/upcoming-deadlines # projects due soon
/entitymanagement/v1/projects/{project}/assignments
/entitymanagement/v1/projects/{project}/archive # · /unarchive

All project endpoints are scoped.

Key fields

FieldNotes
nameRequired; the project's title
projectTypeaudit, compliance, investigation, research, development, consulting
statusLifecycle state — see below
prioritylow, medium, high, critical
startDate, endDate, deadlineDateScheduling; drives the overdue / upcoming-deadlines views
budget, currencyCodeOptional budget tracking
projectCode, slugReferences / identifiers
groupIdThe group/team the project belongs to
description, metadataFreeform

Lifecycle

A project's status moves through:

draft ──▶ active ──▶ on_hold ──▶ completed
│ ▲
│ └──────────┘
└──────────────▶ cancelled
  • draft — created, not yet started.
  • active — in progress.
  • on_hold — paused; can resume to active.
  • completed — finished successfully.
  • cancelled — stopped without completing.

Separately, a project can be archived (isActive: false, archivedAt set) via POST …/archive and restored via POST …/unarchive — archiving is about visibility, independent of the status above.

Assignments

Work is assigned to people and groups:

  • POST /entitymanagement/v1/projects/{project}/assign-user
  • POST /entitymanagement/v1/projects/{project}/assign-group
  • GET /entitymanagement/v1/projects/{project}/assignments lists them.

Per-user permissions on a project are managed under …/projects/{project}/users/{userId}/permissions.

Relationships

  • Belongs to a tenant and, typically, a group/team (groupId).
  • Has user and group assignments that drive who can see and act on it (see Permissions).
  • Carries the shared sub-resources under /entitymanagement/v1/project/{id}/….

See also