Skip to main content

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.

GET/api/integrations/external/estimates/

List all estimates the user can access, with well hierarchy attached

Headers

NameValueDescription
apikeyYOUR_API_KEYYour Forecast API authentication key

Response fields

Each item in the response is a Forecast estimate enriched with its well hierarchy.

Estimate identity

FieldTypeDescription
projectIdstring (UUID)Project / estimate identifier. Use this as :projectId for the time-tracker endpoints.
subjectIdstring (UUID)Subject (well / asset) the estimate is attached to
companyIdstring (UUID)Owning company
estimateNamestringDisplay name of the estimate
designNamestringName 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.

FieldTypeDescription
wellboreId / wellboreidstring (UUID)Wellbore identifier
wellboreName / wellborestringWellbore display name
wellName / wellstringWell display name
wellidstringWell identifier
siteName / sitestringSite display name
siteidstringSite identifier
fieldName / fieldstringField display name
fieldidstringField identifier
countryName / countrystringCountry name
countryidstringCountry 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, wellbore and their *id variants) but will still include the base estimate fields.
  • The projectId returned here is the same ID required by Get Time Tracker and Update Time Tracker Task.