List Designs

Retrieve a list of all designs for a company. Returns all designs that the authenticated user has access to.

You can optionally filter results by design name, hierarchy (country, field, site, well, wellbore), category, or well identifiers (UWI, API number). All filters are case-insensitive and support partial matching.

GET/api/v3/datasets/list?groupid={groupid}

A query parameter groupid (which is a numerical ID for a company) must match the associated API key.

Parameters

Name	Type	Required	Description
groupid	integer	-	Specify by group ID (at least one of groupid or companyid is required)
companyid	string	-	Specify by company UUID (alternative to groupid)
name	string	-	Filter by design name (partial match, case-insensitive)
category	string	-	Filter by design category: 'Prototype', 'Actual', 'Planned', or 'Archived'
country	string	-	Filter by country name (partial match, case-insensitive)
field	string	-	Filter by field name (partial match, case-insensitive)
site	string	-	Filter by site name (partial match, case-insensitive)
well	string	-	Filter by well name (partial match, case-insensitive)
wellbore	string	-	Filter by wellbore name (partial match, case-insensitive)
uwi	string	-	Filter by Unique Well Identifier set on the well or wellbore (partial match)
apiNo	string	-	Filter by API number set on the well or wellbore (partial match)

Filter parameters

All filter parameters are optional. When multiple filters are provided, they are combined with AND logic — a design must match all specified filters.

Parameter	Match type	Description
name	Partial, case-insensitive	Design name
category	Exact match	One of: Prototype, Actual, Planned, Archived
country	Partial, case-insensitive	Country name or code from the well hierarchy
field	Partial, case-insensitive	Field name from the well hierarchy
site	Partial, case-insensitive	Site name from the well hierarchy
well	Partial, case-insensitive	Well name from the well hierarchy
wellbore	Partial, case-insensitive	Wellbore name from the well hierarchy
uwi	Partial, case-insensitive	Unique Well Identifier (set on well or wellbore)
apiNo	Partial, case-insensitive	API number (set on well or wellbore)

Notes

• At least one of groupid or companyid is required
• The API returns all datasets that match the filter criteria — there is no pagination
• Each design includes pipe-separated values for measurements (e.g., "26|m" for 26 meters)
• The category field can be "Prototype", "Actual", "Planned", or "Archived"
• The rigtype field includes values like "semi_submersible", "platform_jackup", "tlp_hybrid", and "land_rig"
• The wellconfiguration field can be "offshore" or "onshore"