API Reference

Organization

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Archive project

POST/organization/projects/{project_id}/archive

Archives a project in the organization. Archived projects cannot be used or updated.

Path ParametersExpand Collapse

project_id: string

ReturnsExpand Collapse

Project = object { id, created_at, name, 3 more }

Represents an individual project.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

The Unix timestamp (in seconds) of when the project was created.

name: string

The name of the project. This appears in reporting.

object: "organization.project"

The object type, which is always organization.project

status: "active" or "archived"

active or archived

One of the following:

"active"

"archived"

archived_at: optional number

The Unix timestamp (in seconds) of when the project was archived or null.

Archive project

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/archive \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project DEF",
    "created_at": 1711471533,
    "archived_at": 1711471533,
    "status": "archived"
}

Returns Examples

{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project DEF",
    "created_at": 1711471533,
    "archived_at": 1711471533,
    "status": "archived"
}