API Reference

Admin

Organization

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List projects

admin.organization.projects.list(**kwargs) -> ConversationCursorPage<Project { id, created_at, object, 4 more } >

GET/organization/projects

Returns a list of projects.

ParametersExpand Collapse

after: String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

include_archived: bool

If true returns all projects including those that have been archived. Archived projects are not included by default.

limit: Integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

ReturnsExpand Collapse

class Project { id, created_at, object, 4 more }

Represents an individual project.

id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

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

formatunixtime

object: :"organization.project"

The object type, which is always organization.project

archived_at: Integer

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

formatunixtime

external_key_id: String

The external key associated with the project.

name: String

The name of the project. This appears in reporting.

status: String

active or archived

List projects

Ruby

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

page = openai.admin.organization.projects.list

puts(page)

{
    "object": "list",
    "data": [
        {
            "id": "proj_abc",
            "object": "organization.project",
            "name": "Project example",
            "created_at": 1711471533,
            "archived_at": null,
            "status": "active"
        }
    ],
    "first_id": "proj-abc",
    "last_id": "proj-xyz",
    "has_more": false
}

Returns Examples

{
    "object": "list",
    "data": [
        {
            "id": "proj_abc",
            "object": "organization.project",
            "name": "Project example",
            "created_at": 1711471533,
            "archived_at": null,
            "status": "active"
        }
    ],
    "first_id": "proj-abc",
    "last_id": "proj-xyz",
    "has_more": false
}