List event types on a project

GET

projects

{project_id}

event_types

List all event types on a project

curl --request GET \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/event_types \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/event_types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "et_aBcD1234eFgH5678",
      "slug": "feedstock-delivery",
      "name": "Feedstock Delivery",
      "description": null,
      "created_at": "2025-02-03T14:19:11.787Z",
      "updated_at": "2025-02-03T14:19:11.787Z",
      "archived_at": null,
      "data_point_types": [
        {
          "id": "dpt_aBcD1234eFgH5678",
          "slug": "feedstock-delivery-mass",
          "name": "Mass of Feedstock Delivery",
          "description": null,
          "value_type": "number",
          "unit": "U.S. ton",
          "is_static": false,
          "nexus_event_type_id": "et_aBcD1234eFgH5678",
          "is_required": true,
          "evidence_check_enabled": false,
          "reusable_in_batches": true,
          "enumeration_options": null,
          "rules": [],
          "created_at": "2025-02-03T14:19:11.787Z",
          "updated_at": "2025-02-03T14:19:11.787Z"
        }
      ],
      "requires_locations": true,
      "requires_tracking_id": false,
      "requires_feedstock": true,
      "requires_asset": false,
      "reusable_in_batches": true,
      "cadence_amount": null,
      "cadence_unit": null,
      "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [
      {
        "field": "name",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "field": "slug",
        "comparator": "eq",
        "value": "feedstock-delivery"
      }
    ],
    "fields": null
  }
}

{
  "errors": [
    {
      "message": "Invalid filter value"
    }
  ]
}

{
  "errors": [
    {
      "message": "API token has expired"
    }
  ]
}

{
  "errors": [
    {
      "message": "You are not authorized to perform this action"
    }
  ]
}

{
  "errors": [
    {
      "message": "Record not found"
    }
  ]
}

{
  "errors": [
    {
      "message": "Project does not have Nexus configuration"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

Query Parameters

page

integer<int32>

default:1

The page to return, starting at 1. A value below 1 or a non-numeric value returns 400.

Required range: x >= 1

page_size

integer<int32>

default:20

Rows per page, from 1 to 200. A value below 1 counts as 1 and a value above 200 as 200; a non-numeric value uses the default.

Required range: 1 <= x <= 200

sort

string

Sortable fields: id, name, slug, created_at, updated_at.

Example:

"name,-created_at"

filter[name][contains]

string

Name contains this text.

filter[slug][eq]

string

archived

enum<string>

Set to "true" to return only archived event types. By default only active (non-archived) event types are returned.

Available options:

true

fields

string

Comma-separated fields to return in each row: id, slug, name, requires_locations, archived_at, created_at, updated_at. Other names are ignored. With response_mode=summary_with_export, a name that isn't an event type field makes the export fail with Invalid export fields.

Example:

"id,slug,name"

response_mode

enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. summary_with_export returns the summary and queues an export of every matching record.

Available options:

default,

summary,

summary_with_export

export_format

enum<string>

default:csv

The export's file format. Applies only with response_mode=summary_with_export.

Available options:

csv,

json

Response

Paginated list. With response_mode=summary, a count and up to 10 samples instead; with summary_with_export, the same plus a queued export.

Option 1
Option 2
Option 3

data

object[]

required

Show child attributes

info

object

required

Where this page sits in the full result, and the sort, filters and fields the request applied.

Show child attributes

List all event types on a project

curl --request GET \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/event_types \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/event_types', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/event_types"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/event_types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "et_aBcD1234eFgH5678",
      "slug": "feedstock-delivery",
      "name": "Feedstock Delivery",
      "description": null,
      "created_at": "2025-02-03T14:19:11.787Z",
      "updated_at": "2025-02-03T14:19:11.787Z",
      "archived_at": null,
      "data_point_types": [
        {
          "id": "dpt_aBcD1234eFgH5678",
          "slug": "feedstock-delivery-mass",
          "name": "Mass of Feedstock Delivery",
          "description": null,
          "value_type": "number",
          "unit": "U.S. ton",
          "is_static": false,
          "nexus_event_type_id": "et_aBcD1234eFgH5678",
          "is_required": true,
          "evidence_check_enabled": false,
          "reusable_in_batches": true,
          "enumeration_options": null,
          "rules": [],
          "created_at": "2025-02-03T14:19:11.787Z",
          "updated_at": "2025-02-03T14:19:11.787Z"
        }
      ],
      "requires_locations": true,
      "requires_tracking_id": false,
      "requires_feedstock": true,
      "requires_asset": false,
      "reusable_in_batches": true,
      "cadence_amount": null,
      "cadence_unit": null,
      "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/event-types/et_aBcD1234eFgH5678"
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [
      {
        "field": "name",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "field": "slug",
        "comparator": "eq",
        "value": "feedstock-delivery"
      }
    ],
    "fields": null
  }
}

{
  "errors": [
    {
      "message": "Invalid filter value"
    }
  ]
}

{
  "errors": [
    {
      "message": "API token has expired"
    }
  ]
}

{
  "errors": [
    {
      "message": "You are not authorized to perform this action"
    }
  ]
}

{
  "errors": [
    {
      "message": "Record not found"
    }
  ]
}

{
  "errors": [
    {
      "message": "Project does not have Nexus configuration"
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Query Parameters

Response