Skip to main content

List Targets

Retrieve all targets for a design. Targets represent geological objectives — drilling destinations defined by a position, a depth, and an optional shape (point, box, sphere, polygon, etc.).

You can optionally filter the result set by name (partial match, case-insensitive) and by depthReference (RKB or MSL). The depthReference query parameter does not filter targets — it controls which depth datum the response is reported in. If omitted, each target is returned using its own stored reference type.

GET/api/v1/designs/{designid}/targets

List all targets defined for the design

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design

Parameters

NameTypeRequiredDescription
namestring-Filter targets by name (partial match, case-insensitive)
depthReferencestring-Depth reference for the returned values: 'RKB' or 'MSL'. Defaults to each target's stored reference type.

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key

Query parameters

ParameterMatch typeDescription
namePartial, case-insensitiveFilter by target name
depthReferenceExactReporting datum: RKB or MSL. Does not filter, only changes the response.

Response fields

Each target in the response includes:

FieldTypeDescription
targetIdstring (UUID)Unique identifier of the target
namestringDisplay name
shapeobjectTarget shape — type plus optional parameters (see Create Target for details)
depthTVDstringTrue vertical depth in pipe-delimited form, e.g. "2500|m"
depthReference"RKB" or "MSL"Depth reference datum
epsgCodestringCoordinate reference system, e.g. "EPSG:32633"
mapPositionEastingstringEasting on the projected map, e.g. "500000|m"
mapPositionNorthingstringNorthing on the projected map, e.g. "6000000|m"
geographicPositionLongitudeDDnumberLongitude in decimal degrees (computed server-side)
geographicPositionLatitudeDDnumberLatitude in decimal degrees (computed server-side)
geographicPositionLongitudeDMSstringLongitude in degrees/minutes/seconds (computed)
geographicPositionLatitudeDMSstringLatitude in degrees/minutes/seconds (computed)
azimuthstringOptional, e.g. "135|deg"
dipAnglestringOptional, e.g. "5|deg"
dipDirectionAzimuthstringOptional, e.g. "180|deg"
confidenceLevelstringOptional drillers-target confidence, e.g. "95|%"

Notes

  • The response wraps the target collection inside an object — each target is keyed by its index ("0", "1", ...) alongside the response status field rc
  • Geographic coordinates (geographicPosition*) are computed from mapPositionEasting/mapPositionNorthing and the design's site coordinate system; they are read-only
  • For polygon targets, mapPositionEasting/mapPositionNorthing are not set — the polygon's points carry the position
  • If the design has no targets, the response is an empty body wrapped in the standard envelope