app.gainforest.organization.info

gainforest.earth

Documentation

A declaration of an organization or project

main record

A declaration of an organization or project

Record Key literal:self Fixed literal value

Properties

country string Required

The country of the organization or project in two letter code (ISO 3166-1 alpha-2)

maxLength: 2 bytesminLength: 2 bytes
createdAt string datetime Required

The date and time of the creation of the record

dataDownloadInfo string Optional

Description of available data downloads

maxGraphemes: 1024 graphemes
dataDownloadUrl string uri Optional

URL to download the organization's data

maxGraphemes: 512 graphemes
dataLicense string Optional

Default license for data published by the organization

maxGraphemes: 256 graphemes
discordId string Optional

Discord server ID for the organization

maxGraphemes: 64 graphemes
displayName string Required

The name of the organization or project

maxLength: 255 bytesminLength: 8 bytes
ecosystemTypes array of string Optional

Types of ecosystems the organization works in

maxLength: 10 items
email string Optional

Contact email for the organization

maxGraphemes: 256 graphemes
focusSpeciesGroups array of string Optional

Species groups the organization focuses on

maxLength: 20 items
foundedYear integer Optional

Year the organization was founded

minimum: 1900maximum: 2100
fundingSourcesDescription string Optional

Description of the organization's funding sources

maxGraphemes: 2048 graphemes
objectives array of string Required

The objectives of the organization or project

startDate string datetime Optional

The start date of the organization or project

stripeUrl string uri Optional

Donation link for the organization

maxGraphemes: 512 graphemes
teamSize integer Optional

Number of team members in the organization

minimum: 1
visibility string Required

The visibility of the organization or project in the Green Globe

maxGraphemes: 32 graphemes
Allowed: Public, Unlisted
website string uri Optional

The website of the organization or project

maxGraphemes: 512 graphemes
View raw schema
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "displayName",
      "shortDescription",
      "longDescription",
      "objectives",
      "country",
      "visibility",
      "createdAt"
    ],
    "properties": {
      "logo": {
        "ref": "org.hypercerts.defs#smallImage",
        "type": "ref",
        "description": "Logo for the organization"
      },
      "email": {
        "type": "string",
        "description": "Contact email for the organization",
        "maxGraphemes": 256
      },
      "country": {
        "type": "string",
        "maxLength": 2,
        "minLength": 2,
        "description": "The country of the organization or project in two letter code (ISO 3166-1 alpha-2)"
      },
      "website": {
        "type": "string",
        "format": "uri",
        "description": "The website of the organization or project",
        "maxGraphemes": 512
      },
      "teamSize": {
        "type": "integer",
        "minimum": 1,
        "description": "Number of team members in the organization"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "The date and time of the creation of the record"
      },
      "discordId": {
        "type": "string",
        "description": "Discord server ID for the organization",
        "maxGraphemes": 64
      },
      "startDate": {
        "type": "string",
        "format": "datetime",
        "description": "The start date of the organization or project"
      },
      "stripeUrl": {
        "type": "string",
        "format": "uri",
        "description": "Donation link for the organization",
        "maxGraphemes": 512
      },
      "coverImage": {
        "ref": "org.hypercerts.defs#smallImage",
        "type": "ref",
        "description": "Cover image for the organization"
      },
      "objectives": {
        "type": "array",
        "items": {
          "enum": [
            "Conservation",
            "Research",
            "Education",
            "Community",
            "Other"
          ],
          "type": "string",
          "maxGraphemes": 64
        },
        "description": "The objectives of the organization or project"
      },
      "visibility": {
        "enum": [
          "Public",
          "Unlisted"
        ],
        "type": "string",
        "description": "The visibility of the organization or project in the Green Globe",
        "maxGraphemes": 32
      },
      "dataLicense": {
        "type": "string",
        "description": "Default license for data published by the organization",
        "maxGraphemes": 256
      },
      "displayName": {
        "type": "string",
        "maxLength": 255,
        "minLength": 8,
        "description": "The name of the organization or project"
      },
      "foundedYear": {
        "type": "integer",
        "maximum": 2100,
        "minimum": 1900,
        "description": "Year the organization was founded"
      },
      "socialLinks": {
        "type": "array",
        "items": {
          "ref": "#socialLink",
          "type": "ref"
        },
        "maxLength": 10,
        "description": "Social media links for the organization"
      },
      "ecosystemTypes": {
        "type": "array",
        "items": {
          "type": "string",
          "knownValues": [
            "tropical-rainforest",
            "temperate-forest",
            "boreal-forest",
            "mangrove",
            "coral-reef",
            "savanna",
            "grassland",
            "wetland",
            "desert",
            "alpine",
            "marine",
            "freshwater",
            "urban",
            "agroforestry",
            "other"
          ],
          "maxGraphemes": 128
        },
        "maxLength": 10,
        "description": "Types of ecosystems the organization works in"
      },
      "dataDownloadUrl": {
        "type": "string",
        "format": "uri",
        "description": "URL to download the organization's data",
        "maxGraphemes": 512
      },
      "longDescription": {
        "ref": "pub.leaflet.pages.linearDocument",
        "type": "ref",
        "description": "The long description of the organization or project in richtext"
      },
      "dataDownloadInfo": {
        "type": "string",
        "description": "Description of available data downloads",
        "maxGraphemes": 1024
      },
      "shortDescription": {
        "ref": "app.gainforest.common.defs#richtext",
        "type": "ref",
        "description": "The description of the organization or project"
      },
      "focusSpeciesGroups": {
        "type": "array",
        "items": {
          "type": "string",
          "knownValues": [
            "mammals",
            "birds",
            "reptiles",
            "amphibians",
            "fish",
            "insects",
            "arachnids",
            "mollusks",
            "crustaceans",
            "trees",
            "shrubs",
            "herbs",
            "grasses",
            "ferns",
            "mosses",
            "fungi",
            "algae",
            "coral",
            "other"
          ],
          "maxGraphemes": 64
        },
        "maxLength": 20,
        "description": "Species groups the organization focuses on"
      },
      "fundingSourcesDescription": {
        "type": "string",
        "description": "Description of the organization's funding sources",
        "maxGraphemes": 2048
      }
    }
  },
  "description": "A declaration of an organization or project"
}
socialLink object

A social media link for an organization

Properties

platform string Required

The social media platform

maxGraphemes: 64 graphemes
Known values: twitter, instagram, facebook, linkedin, youtube, tiktok, github, discord, telegram, other
url string uri Required

The URL of the social media profile or page

maxGraphemes: 512 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "platform",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the social media profile or page",
      "maxGraphemes": 512
    },
    "platform": {
      "type": "string",
      "description": "The social media platform",
      "knownValues": [
        "twitter",
        "instagram",
        "facebook",
        "linkedin",
        "youtube",
        "tiktok",
        "github",
        "discord",
        "telegram",
        "other"
      ],
      "maxGraphemes": 64
    }
  },
  "description": "A social media link for an organization"
}

Lexicon Garden

@