List Estimates
Retrieve all Forecast estimates the authenticated user has access to, across every company they are a member of. Each estimate is returned with its full well hierarchy (country → field → site → well → wellbore) so the response can be consumed without additional lookups.
This endpoint is the canonical entry point for external integrations: use it to discover projectId values, then call the time-tracker endpoints with those IDs.
List all estimates the user can access, with well hierarchy attached
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your Forecast API authentication key |
Response fields
Each item in the response is a Forecast estimate enriched with its well hierarchy.
Estimate identity
| Field | Type | Description |
|---|---|---|
projectId | string (UUID) | Project / estimate identifier. Use this as :projectId for the time-tracker endpoints. |
subjectId | string (UUID) | Subject (well / asset) the estimate is attached to |
companyId | string (UUID) | Owning company |
estimateName | string | Display name of the estimate |
designName | string | Name of the WellDesign design the estimate is based on |
Hierarchy fields
The hierarchy is resolved from the wellbore and merged into the estimate. Fields are present when the wellbore has a complete hierarchy assignment.
| Field | Type | Description |
|---|---|---|
wellboreId / wellboreid | string (UUID) | Wellbore identifier |
wellboreName / wellbore | string | Wellbore display name |
wellName / well | string | Well display name |
wellid | string | Well identifier |
siteName / site | string | Site display name |
siteid | string | Site identifier |
fieldName / field | string | Field display name |
fieldid | string | Field identifier |
countryName / country | string | Country name |
countryid | string | Country identifier |
Notes
- The response is scoped to the companies the authenticated user belongs to. There is no pagination — all matching estimates are returned in one array.
- Estimates whose wellbore has not been placed in the hierarchy will be missing the lowercase hierarchy fields (
country,field,site,well,wellboreand their*idvariants) but will still include the base estimate fields. - The
projectIdreturned here is the same ID required by Get Time Tracker and Update Time Tracker Task.