API reference · Projects
Archive a project (projects are never deleted)
/v1/orgs/{org_id}/projects/{project_id}/archiveMakes the project read-only: its resources can still be read, but any change inside it answers 409 project_archived until it is restored. Archiving an archived project returns it unchanged.
Console session only: no API key can be granted the project:delete permission it needs. Requires the project:delete permission (a key's scope, or a role that includes it).
Request
Path parameters
org_idstringYour organization. The SDKs and the CLI fill it in from the API key.
ID with prefix org_
project_idstringrequiredID of the project
ID with prefix prj_
Response
200 Project — The project
objectstringrequiredAlways `project`: the type of this object
One of
projectidstringrequiredUnique ID (`prj_…`)
ID with prefix prj_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
namestringrequiredIts name
slugstringrequiredShort URL-safe name, unique within the organization
descriptionstring | nullrequiredFree-text description
archived_atstring (date-time) | nullrequiredWhen it was archived (null while it is active) (ISO 8601, UTC)
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
Example response
{
"object": "project",
"id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"name": "string",
"slug": "string",
"description": "string",
"archived_at": "2026-01-01T00:00:00.000Z",
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
409 | conflict_error | The resource's current state does not allow this. |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |