Projects

Project management endpoints

List organization projects

get

Retrieve all projects in an organization with optional filtering

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

Query parameters

pageinteger · min: 1Optional

The page number to retrieve.

Default: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20

searchstringOptional

Search term to filter projects by name

Responses

200

Organization projects retrieved successfully

application/json

400

Invalid organization ID or query parameters.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to list organization projects.

application/json

404

Organization not found.

application/json

500

Internal server error occurred while retrieving projects.

application/json

get

/api/v1/orgs/{org_id}/projects

HTTPcURLJavaScriptPython

GET /api/v1/orgs/{org_id}/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "prj-3Yk9mPqR",
      "name": "My Project",
      "description": "Production environment for our main service",
      "status": "active"
    }
  ],
  "pagination": {
    "total_items": 100,
    "total_pages": 10,
    "current_page": 1,
    "items_per_page": 5
  }
}

Create project in organization

post

Create a new project within an organization

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

Body

application/json

Request payload for creating or updating a project

namestring · min: 1 · max: 100Required

Name of the project (1-100 characters)

Example: My Project

descriptionstringOptional

Optional description of the project's purpose or environment

Example: Production environment for our main service

Responses

201

Project created successfully

application/json

400

Invalid project data format or missing required fields.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to create project.

application/json

404

Organization not found.

application/json

409

Project with the same name already exists in the organization.

application/json

500

Internal server error occurred while creating project.

application/json

post

/api/v1/orgs/{org_id}/projects

HTTPcURLJavaScriptPython

POST /api/v1/orgs/{org_id}/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "My Project",
  "description": "Production environment for our main service"
}

{
  "id": "prj-3Yk9mPqR",
  "name": "My Project",
  "description": "Production environment for our main service",
  "status": "active"
}

Get project in organization

get

Retrieve project details by ID within an organization

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

project_idstringRequired

Project ID

Responses

200

Project retrieved successfully

application/json

400

Invalid organization ID or project ID format.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to view project details.

application/json

404

Organization or project not found.

application/json

500

Internal server error occurred while retrieving project.

application/json

get

/api/v1/orgs/{org_id}/projects/{project_id}

HTTPcURLJavaScriptPython

GET /api/v1/orgs/{org_id}/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "prj-3Yk9mPqR",
  "name": "My Project",
  "description": "Production environment for our main service",
  "status": "active"
}

Delete project in organization

delete

Delete project by ID within an organization

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

project_idstringRequired

Project ID

Responses

200

Project deleted successfully

application/json

400

Invalid organization ID or project ID format.

application/json

401

Missing or invalid authentication token.

application/json

403

Insufficient permissions to delete project.

application/json

404

Organization or project not found.

application/json

500

Internal server error occurred while deleting project.

application/json

delete

/api/v1/orgs/{org_id}/projects/{project_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/orgs/{org_id}/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Operation completed successfully"
}