Projects API
Manage projects via the REST API.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /projects | List all accessible projects |
POST | /projects | Create a new project |
GET | /projects/{id} | Get a project by ID |
PATCH | /projects/{id} | Update project metadata |
DELETE | /projects/{id} | Delete a project |
GET /projects
Returns a paginated list of projects the authenticated user has access to.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | integer | Max results per page (default: 50, max: 200) |
cursor | string | Pagination cursor from previous response |
Response
json
{
"data": [
{
"id": "proj-001",
"name": "Permian Basin Asset",
"description": "Delaware Basin development wells",
"timezone": "America/Chicago",
"unitSystem": "imperial",
"wellCount": 42,
"createdAt": "2024-01-15T08:00:00Z",
"updatedAt": "2025-03-01T14:22:00Z"
}
],
"nextCursor": null,
"total": 3
}POST /projects
Create a new project.
Request Body
json
{
"name": "Eagle Ford Asset",
"description": "South Texas oil producers",
"timezone": "America/Chicago",
"unitSystem": "imperial"
}Response — 201 Created
json
{
"id": "proj-002",
"name": "Eagle Ford Asset",
"description": "South Texas oil producers",
"timezone": "America/Chicago",
"unitSystem": "imperial",
"wellCount": 0,
"createdAt": "2026-01-10T09:00:00Z",
"updatedAt": "2026-01-10T09:00:00Z"
}GET /projects/{id}
Get a single project by its ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Project ID |
Response — 200 OK (same shape as single item in list response)
PATCH /projects/{id}
Partially update project metadata. Only fields included in the body are updated.
Request Body (all fields optional)
json
{
"name": "Eagle Ford Asset — Phase 2",
"description": "Updated description",
"unitSystem": "metric"
}Response — 200 OK with updated project object.
DELETE /projects/{id}
CAUTION
Deleting a project permanently removes all associated wells, production data, dashboards, and surfaces. This action cannot be undone.
Response — 204 No Content