Pages

Get project data fields

Returns available data field definitions for renewable energy projects.

GET https://api.renewmap.com.au/api/v1/project/fields
Requires API key in Authorization header. See Getting started for authentication details.

Query parameters

Name Type Default Description
limit integer 100 Limit the number of results returned (maximum 10000)
offset integer 0 Offset from the first record returned (for pagination)

Example request

curl --request GET \
  --url 'https://api.renewmap.com.au/api/v1/project/fields' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'accept: application/json'

Example response

{
  "fields": [
    {
      "id": "75433bca-8135-421c-892a-66f586eaa49c",
      "field_name": "Hub Height (m)",
      "field_type": "array",
      "description": "Height of turbine hub above ground level",
      "group_name": "Infrastructure",
      "rank": 1004
    }
  ]
}

Each field definition includes:

  • field_name — Human-readable name of the data field
  • field_type — Data type (e.g. string, array, number)
  • group_name — Logical grouping for display purposes
  • rank — Sort order within the group