Wells API

Manage wells within a project via the REST API.

Endpoints

Method	Path	Description
GET	/projects/{projectId}/wells	List wells in a project
POST	/projects/{projectId}/wells	Create a new well
GET	/projects/{projectId}/wells/{wellId}	Get a well by ID
PATCH	/projects/{projectId}/wells/{wellId}	Update well attributes
DELETE	/projects/{projectId}/wells/{wellId}	Delete a well

---

GET /projects/{projectId}/wells

List all wells in a project.

Query Parameters

Parameter	Type	Description
limit	integer	Max results per page (default: 100)
cursor	string	Pagination cursor
type	string	Filter by type: producer, injector, observer, swd
status	string	Filter by status: active, inactive, shut_in
search	string	Search by well name or API number

Response

{
  "data": [
    {
      "id": "well-001",
      "projectId": "proj-001",
      "name": "Horizon 14-3H",
      "apiNumber": "4201500123456",
      "type": "producer",
      "status": "active",
      "latitude": 31.9521,
      "longitude": -102.1225,
      "spudDate": "2020-03-15",
      "firstProductionDate": "2020-07-01",
      "lateralLength": 7500,
      "perfInterval": { "topMd": 8500, "bottomMd": 9200 },
      "createdAt": "2024-02-01T00:00:00Z"
    }
  ],
  "nextCursor": "eyJpZCI6...",
  "total": 42
}

---

POST /projects/{projectId}/wells

Create a new well in a project.

Request Body

{
  "name": "Horizon 15-1H",
  "apiNumber": "4201500654321",
  "type": "producer",
  "status": "active",
  "latitude": 31.9601,
  "longitude": -102.1310,
  "spudDate": "2025-06-01",
  "lateralLength": 8200,
  "perfInterval": { "topMd": 9100, "bottomMd": 9850 }
}

Response — 201 Created with the created well object.

---

PATCH /projects/{projectId}/wells/{wellId}

Update well attributes. Only included fields are modified.

Request Body (all optional)

{
  "status": "shut_in",
  "name": "Horizon 14-3H (WO)"
}

Response — 200 OK with updated well object.

---

DELETE /projects/{projectId}/wells/{wellId}

CAUTION

Deletes the well and all associated production data. This action cannot be undone.

Response — 204 No Content

---

Next Steps

• Production Data API →
• Projects API →