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
| Name | Type | Required | Description |
|---|---|---|---|
designid | string (UUID) | ✓ | The UUID of the design |
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | - | Filter targets by name (partial match, case-insensitive) |
depthReference | string | - | Depth reference for the returned values: 'RKB' or 'MSL'. Defaults to each target's stored reference type. |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Query parameters
| Parameter | Match type | Description |
|---|---|---|
name | Partial, case-insensitive | Filter by target name |
depthReference | Exact | Reporting datum: RKB or MSL. Does not filter, only changes the response. |
Response fields
Each target in the response includes:
| Field | Type | Description |
|---|---|---|
targetId | string (UUID) | Unique identifier of the target |
name | string | Display name |
shape | object | Target shape — type plus optional parameters (see Create Target for details) |
depthTVD | string | True vertical depth in pipe-delimited form, e.g. "2500|m" |
depthReference | "RKB" or "MSL" | Depth reference datum |
epsgCode | string | Coordinate reference system, e.g. "EPSG:32633" |
mapPositionEasting | string | Easting on the projected map, e.g. "500000|m" |
mapPositionNorthing | string | Northing on the projected map, e.g. "6000000|m" |
geographicPositionLongitudeDD | number | Longitude in decimal degrees (computed server-side) |
geographicPositionLatitudeDD | number | Latitude in decimal degrees (computed server-side) |
geographicPositionLongitudeDMS | string | Longitude in degrees/minutes/seconds (computed) |
geographicPositionLatitudeDMS | string | Latitude in degrees/minutes/seconds (computed) |
azimuth | string | Optional, e.g. "135|deg" |
dipAngle | string | Optional, e.g. "5|deg" |
dipDirectionAzimuth | string | Optional, e.g. "180|deg" |
confidenceLevel | string | Optional 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 fieldrc - Geographic coordinates (
geographicPosition*) are computed frommapPositionEasting/mapPositionNorthingand the design's site coordinate system; they are read-only - For polygon targets,
mapPositionEasting/mapPositionNorthingare 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