Archive a project (tenant:forge:write and project admin, or tenant:forge:admin)
POST /api/forge/v1/projects/{key}/archive
Module: Forge · operationId: archiveForgeProject · Tag: Projects · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:admin, or tenant:forge:write and project role admin. An archived project's configuration and items are read-only (409 project_archived).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Responses
- 200 Archived (
application/json) - 403 Error (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
acceptsIntake(boolean, required): Callers with onlytenant:forge:intakemay hand desk tickets to the projectaccess(Capabilities, required)canConfigure(boolean, required): Change the project configuration (statuses, types, labels, fields, templates, repositories)canCreateItem(boolean, required): Create items and commentcanDeleteItem(boolean, required): Delete items and anyone's commentscanEditItem(boolean, required): Edit items (status, fields, labels, assignees, sections, links)canManage(boolean, required): Members, project settings, archive, deletecanPlan(boolean, required): Create, edit, close and reopen milestones; create, edit, start, close and delete iterations and put items into them (the rule of canEditItem)canUseAgent(boolean, required): The planning agent may work on this item for the caller (canEditItem, the project enabled the agent, active project, not converted); always false on a projectmember(boolean, required): The caller is a member of the projectrole(string, required): Effective role; empty when none
createdAt(string (date-time), required): When the project was createdcreatedBy(string, required): E-mail of who created the projectdescription(string, required): Markdownid(string (uuid), required): Project idkey(string, required): Project key, prefix of item references (APP-12); never changesname(string, required): Project namesettings(object, required): Project settings (handoff, code intake, planning agent), each changed through its own PUT routestate(string, required): active or archived (archived: read-only) (one ofactive,archived)updatedAt(string (date-time), required): Last changeversion(integer, required): Optimistic-locking version; send it with PATCHvisibility(string, required):private: members and tenant forge admins;tenant: every forge reader (one ofprivate,tenant)defaultTypeId(string (uuid), nullable): Default item type of new items; null when nonespentMinutes(integer, nullable, read-only): Work HR booked with the project as reference (forge:project:<id>, worked minus breaks, ADR 0040); filled by the project read and list, null when HR does not answer (never an error)workCustomer(WorkCustomer | null): How work on the project and its items is booked in HR (ADR 0040); null = no setting (the person picks the customer)
Example 200 answer:
{
"acceptsIntake": true,
"access": {
"canConfigure": false,
"canCreateItem": false,
"canDeleteItem": false,
"canEditItem": false,
"canManage": true,
"canPlan": false,
"canUseAgent": false,
"member": true,
"role": "admin"
},
"createdAt": "2026-09-23T09:00:00Z",
"createdBy": "emma.maier@muster-it.example",
"defaultTypeId": "7f3a4b5c-6d7e-4f8a-9b9c-3d4e5f6a7b03",
"description": "Die mobile App für Kunden von Muster IT: Tickets ansehen, Rückfragen beantworten und Geräte-Inventar einsehen.",
"id": "0b6c1e1e-3f0b-4e8e-9f3f-1d2c3b4a5f60",
"key": "APP",
"name": "Kundenportal-App",
"settings": {},
"state": "archived",
"updatedAt": "2026-11-18T08:00:00Z",
"version": 8,
"visibility": "tenant",
"workCustomer": null
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/forge/v1/projects/string/archive' \
-H "Authorization: Bearer $ACCESS_TOKEN"