Projects API
A project is one client engagement from discovery to maintenance: the container every component, environment, epic, story, requirement, test, release and incident lives under.
A project is one client engagement from discovery to maintenance: the container every component, environment, epic, story, requirement, test, release and incident lives under. It carries a short key (CRM) that prefixes every reference in it (CRM-142), a lifecycle status, the methodology it is run with, its visibility within the team, its four leads and its dates.
The reads here see the registry as the token sees it: every project of the team with visibility: team, plus the ones the person holds a membership row on, narrowed further by the token's scope:project: entries. A project outside that set is a 404 RESOURCE_NOT_FOUND, never a 403, so the API cannot be used to learn that a project exists. Every write runs the same action the registry page runs, under the same permissions (the team owner, then the person's project role, then their team role), and announces itself as a project.* event.
Endpoints
/v1/projectsList projectsPOST/v1/projectsCreate a projectGET/v1/projects/{project}Get a projectPATCH/v1/projects/{project}Update a projectDELETE/v1/projects/{project}Delete a projectPOST/v1/projects/{project}/archiveArchive a projectPOST/v1/projects/{project}/restoreRestore a projectRelated
How is this guide?
Last updated on