All locations on a project

GET

projects

{project_id}

locations

List all locations on a project

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

import requests

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

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}/locations', 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}/locations",
  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}/locations"

	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}/locations")

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": "loc_aBcD1234eFgH5678",
      "lat": "45.5",
      "long": "-122.5",
      "name": "Production Facility",
      "is_primary": true,
      "created_at": "2024-12-20T02:49:37.569Z",
      "updated_at": "2024-12-20T02:49:37.569Z",
      "address": {
        "name": "Production Facility",
        "street_address_1": null,
        "street_address_2": null,
        "city": null,
        "state": null,
        "postal_code": null,
        "country": "CA",
        "created_at": "2024-12-20T02:49:37.569Z",
        "updated_at": "2024-12-20T02:49:37.569Z"
      }
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": [],
    "fields": null
  }
}

{
  "errors": [
    {
      "message": "Unsupported filter 'name'. Filterable fields: is_primary."
    }
  ]
}

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

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

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

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, created_at, updated_at. These use the project link's own timestamps, not the location's: created_at is when the location was added to the project, and updated_at also moves when this location's is_primary is set through this API.

Example:

"-created_at"

filter[is_primary][eq]

boolean

fields

string

Comma-separated fields to return in each row: id, lat, long, name, is_primary, created_at, updated_at. Other names are ignored.

response_mode

enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. This endpoint doesn't support summary_with_export, which returns 400.

Available options:

default,

summary

Response

Paginated list. With response_mode=summary, a count and up to 10 samples instead.

Option 1
Option 2

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 locations on a project

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

import requests

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

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}/locations', 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}/locations",
  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}/locations"

	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}/locations")

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": "loc_aBcD1234eFgH5678",
      "lat": "45.5",
      "long": "-122.5",
      "name": "Production Facility",
      "is_primary": true,
      "created_at": "2024-12-20T02:49:37.569Z",
      "updated_at": "2024-12-20T02:49:37.569Z",
      "address": {
        "name": "Production Facility",
        "street_address_1": null,
        "street_address_2": null,
        "city": null,
        "state": null,
        "postal_code": null,
        "country": "CA",
        "created_at": "2024-12-20T02:49:37.569Z",
        "updated_at": "2024-12-20T02:49:37.569Z"
      }
    }
  ],
  "info": {
    "items": 1,
    "page_size": 20,
    "total_items": 1,
    "current_page": 1,
    "next_page": null,
    "previous_page": null,
    "total_pages": 1,
    "sort": [],
    "filter": [],
    "fields": null
  }
}

{
  "errors": [
    {
      "message": "Unsupported filter 'name'. Filterable fields: is_primary."
    }
  ]
}

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

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

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

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Query Parameters

Response