Skip to content
Product Docs

Projects

List Projects
client.projects.list(ProjectListParams { name, organization_id, page_size, page_token } query?, RequestOptionsoptions?): PaginatedCursor<Project { id, name, organization_id, 3 more } >
GET/api/v2/projects
Create Project
client.projects.create(ProjectCreateParams { organization_id, name } params, RequestOptionsoptions?): Project { id, name, organization_id, 3 more }
POST/api/v2/projects
Get Project
client.projects.get(stringprojectID, ProjectGetParams { organization_id } query?, RequestOptionsoptions?): Project { id, name, organization_id, 3 more }
GET/api/v2/projects/{project_id}
Update Existing Project
client.projects.update(stringprojectID, ProjectUpdateParams { name, organization_id } params, RequestOptionsoptions?): Project { id, name, organization_id, 3 more }
PUT/api/v2/projects/{project_id}
Delete Project
client.projects.delete(stringprojectID, ProjectDeleteParams { organization_id } params?, RequestOptionsoptions?): void
DELETE/api/v2/projects/{project_id}
ModelsExpand Collapse
Project { id, name, organization_id, 3 more }

API response schema for a project.

id: string

The project’s unique identifier.

name: string

The project’s display name.

organization_id: string

The organization the project belongs to.

created_at?: string | null

Creation datetime

formatdate-time
is_default?: boolean

Whether this project is the default project for its organization.

updated_at?: string | null

Update datetime

formatdate-time