API Reference

Admin

Organization

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Archive project

$ openai admin:organization:projects archive

POST/organization/projects/{project_id}/archive

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

ParametersExpand Collapse

--project-id: string

The ID of the project.

ReturnsExpand Collapse

project: object { id, created_at, object, 4 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.

object: "organization.project"

The object type, which is always organization.project

archived_at: optional number

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

external_key_id: optional string

The external key associated with the project.

name: optional string

The name of the project. This appears in reporting.

status: optional string

active or archived

Archive project

CLI Tool

HTTP

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

openai admin:organization:projects archive \
  --admin-api-key 'My Admin API Key' \
  --project-id project_id

{
    "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"
}