This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

API services

How to import and get data!

1: Quick reference
2: GET data
3: Post data
4: Put data

Every OpenDataBio installation provide a API service, allowing users to GET data programmatically, and collaborators to POST new data into its database. The service is open access to public data, requires user authentication to POST data or GET data of restricted access.

The OpenDataBio API (Application Programming Interface -API) allows users to interact with an OpenDataBio database for exporting, importing and updating data without using the web-interface.

The OpenDataBio R package is a client for this API, allowing the interaction with the data repository directly from R and illustrating the API capabilities so that other clients can be easily built.

The OpenDataBio API allows querying of the database, data importation and data edition (update) through a REST inspired interface. All API requests and responses are formatted in JSON.

The API call

A simple call to the OpenDataBio API has four independent pieces:

[HTTP-verb] + base-URL + endpoint + request-parameters

HTTP-verb - either GET for exports or POST for imports.
base-URL - the URL used to access your OpenDataBio server + plus /api/v0. For, example, http://opendatabio.inpa.gov.br/api/v0
endpoint - represents the object or collection of objects that you want to access, for example, for querying taxonomic names, the endpoint is “taxons”
request-parameters - represent filtering and processing that should be done with the objects, and are represented in the API call after a question mark. For example, to retrieve only valid taxonomic names (non synonyms) end the request with ?valid=1.

The API call above can be entered in a browser to GET public access data. For example, to get the list of valid taxons from an OpenDataBio installation the API request could be:

https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit=10

When using the OpenDataBio R package this call would be odb_get_taxons(list(valid=1)).

A response would be something like:

{
  "meta":
  {
    "odb_version":"0.9.1-alpha1",
    "api_version":"v0",
    "server":"http://opendb.inpa.gov.br",
    "full_url":"https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit1&offset=100"},
    "data":
    [
      {
        "id":62,
        "parent_id":25,
        "author_id":null,
        "scientificName":"Laurales",
        "taxonRank":"Ordem",
        "scientificNameAuthorship":null,
        "namePublishedIn":"Juss. ex Bercht. & J. Presl. In: Prir. Rostlin: 235. (1820).",
        "parentName":"Magnoliidae",
        "family":null,
        "taxonRemarks":null,
        "taxonomicStatus":"accepted",
        "ScientificNameID":"http:\/\/tropicos.org\/Name\/43000015 | https:\/\/www.gbif.org\/species\/407",
        "basisOfRecord":"Taxon"
    }]}

API Authentication

Not required for getting any data with public access in the ODB database, which by default includes locations, taxons, bibliographic references, persons and traits.
Authentication Required to GET any data that is not of public access, and is required to POST and PUT data.

Authentication is done using an API token, that can be found under your user profile on the web interface. The token is assigned to a single database user, and should not be shared, exposed, e-mailed or stored in version controls.
To authenticate against the OpenDataBio API, use the token in the “Authorization” header of the API request. When using the R client, pass the token to the odb_config function cfg = odb_config(token="your-token-here").
The token controls the data you can get and can edit

Users will only have access to the data for which the user has permission and to any data with public access in the database, which by default includes locations, taxons, bibliographic references, persons and traits. Measurements, individuals, and Vouchers access depends on permissions understood by the users token.

API versions

The OpenDataBio API follows its own version number. This means that the client can expect to use the same code and get the same answers regardless of which OpenDataBio version that the server is running. All changes done within the same API version (>= 1) should be backward compatible. Our API versioning is handled by the URL, so to ask for a specific API version, use the version number between the base URL and endpoint:

https://opendatabio.inpa.gov.br/opendatabio/api/v1/taxons

https://opendatabio.inpa.gov.br/opendatabio/api/v2/taxons

1 - Quick reference

List of endpoints and parameters!

API call format

base-URL + ‘/api/v0/’ + endpoint + ‘?’ + request-parameters

Taxons endpoint example

https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit=2&offset=10

GET DATA (downloads)

Shared get-parameters

When multiple parameters are specified, they are combined with an AND operator. There is no OR parameter option in searches.

Download large datasets?

The limit and offset parameters can be used to divide your search into parts. Alternatively, use the save_job=T option and then download the data with the get_file=T parameter from the userjobs API.

wildcards

Some parameters accept an asterisk as wildcard, so api/v0/taxons?name=Euterpe will return taxons with name exactly as “Euterpe”, while api/v0/taxons?name=Eut* will return names starting with “Eut”.

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`

Endpoint parameters

Endpoint	Description	Parameters
/	Tests your access/token.	—
bibreferences	Bibliographic references (GET lists, POST creates).	id, bibkey, biocollection, dataset, fields, job_id, limit, offset, save_job, search, taxon, taxon_root
biocollections	Biocollections (GET lists, POST creates).	id, acronym, fields, irn, job_id, limit, name, offset, save_job, search
datasets	Datasets and published dataset versions (GET lists, POST creates via import job).	id, bibreference, fields, has_versions, include_url, limit, list_versions, name, offset, project, save_job, search, summarize, tag, tagged_with, taxon, taxon_root, traits, version_id, version_uuid
individuals	Individuals (GET lists, POST creates, PUT updates).	id, dataset, date_max, date_min, fields, job_id, limit, location, location_root, odbrequest_id, offset, person, project, save_job, tag, taxon, taxon_root, trait, vernacular
individual-locations	Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).	id, dataset, date_max, date_min, fields, individual, limit, location, location_root, offset, person, project, save_job, tag, taxon, taxon_root
languages	Lists available interface/data languages.	fields, limit, offset
locations	Locations (GET lists, POST creates, PUT updates).	id, adm_level, dataset, fields, job_id, lat, limit, location_root, long, name, offset, parent_id, project, querytype, root, save_job, search, taxon, taxon_root, trait
measurements	Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).	id, bibreference, dataset, date_max, date_min, fields, individual, job_id, limit, location, location_root, measured_id, measured_type, offset, person, project, save_job, taxon, taxon_root, trait, trait_type, voucher
media	Media metadata (GET lists, POST creates, PUT updates).	id, dataset, fields, individual, job_id, limit, location, location_root, media_id, media_uuid, offset, person, project, save_job, tag, taxon, taxon_root, uuid, voucher
persons	People (GET lists, POST creates, PUT updates).	id, abbrev, email, fields, job_id, limit, name, offset, save_job, search
projects	Projects (GET lists).	id, fields, job_id, limit, offset, save_job, search, tag
taxons	Taxonomic names (GET lists, POST creates).	id, bibreference, biocollection, dataset, external, fields, job_id, level, limit, location_root, name, offset, person, project, root, save_job, taxon_root, trait, valid, vernacular
traits	Trait definitions (GET lists, POST creates).	id, bibreference, categories, dataset, fields, job_id, language, limit, name, object_type, offset, save_job, search, tag, taxon, taxon_root, trait, type
vernaculars	Vernacular names (GET lists, POST creates).	id, fields, individual, job_id, limit, location, location_root, offset, save_job, taxon, taxon_root
vouchers	Voucher specimens (GET lists, POST creates, PUT updates).	id, bibreference, bibreference_id, biocollection, biocollection_id, collector, dataset, date_max, date_min, fields, individual, job_id, limit, location, location_root, main_collector, number, odbrequest_id, offset, person, project, save_job, taxon, taxon_root, trait, vernacular
userjobs	Background jobs (imports/exports) (GET lists).	id, fields, get_file, limit, offset, status
activities	Lists activity log entries.	id, description, fields, individual, language, limit, location, log_name, measurement, offset, save_job, subject, subject_id, taxon, taxon_root, voucher
tags	Tags/keywords (GET lists).	id, dataset, fields, job_id, language, limit, name, offset, project, save_job, search, trait
brahms	BRAHMS/INPA formatted individual export (GET lists, queued export with save_job).	id, brahms_level, dataset, date_max, date_min, fields, habitattxt_traits, habitattxt_traits_header, include_taxon_vernaculars, include_vernaculars, include_voucher_individuals, job_id, lang, limit, location, location_root, locnotes_traits, locnotes_traits_header, measurement_dataset, odbrequest_id, offset, person, plantdesc_traits, plantdesc_traits_header, project, save_job, tag, taxon, taxon_root, trait, vernacular
identification-histories	Identification history records (GET lists, POST creates manual history rows).	id, biocollection, date_max, date_min, fields, identification_id, individual, individual_id, job_id, limit, offset, person, save_job, source, taxon, taxon_root

POST DATA (imports)

Web-interface note

Importing data from files through the web-interface require specifying the POST verb parameters of the ODB API

Endpoint	Description	Parameters
bibreferences	Bibliographic references (GET lists, POST creates).	bibtex, doi
biocollections	Biocollections (GET lists, POST creates).	acronym, name
individuals	Individuals (GET lists, POST creates, PUT updates).	altitude, angle, biocollection, biocollection_number, biocollection_type, collector, dataset, date, distance, identification_based_on_biocollection, identification_based_on_biocollection_number, identification_date, identification_individual, identification_notes, identifier, latitude, location, location_date_time, location_notes, longitude, modifier, notes, tag, taxon, x, y
individual-locations	Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).	altitude, angle, distance, individual, latitude, location, location_date_time, location_notes, longitude, x, y
locations	Locations (GET lists, POST creates, PUT updates).	adm_level, altitude, azimuth, datum, geojson, geom, ismarine, lat, long, name, notes, parent, startx, starty, x, y
locations-validation	Validates coordinates against registered locations (POST).	latitude, longitude
measurements	Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).	bibreference, dataset, date, duplicated, link_id, location, notes, object_id, object_type, parent_measurement, person, trait_id, value
media	Media metadata (GET lists, POST creates, PUT updates).	collector, dataset, date, filename, latitude, license, location, longitude, notes, object_id, object_type, project, tags, title_en, title_pt
persons	People (GET lists, POST creates, PUT updates).	abbreviation, biocollection, email, full_name, institution
taxons	Taxonomic names (GET lists, POST creates).	author, author_id, bibkey, bibreference, enforceValid, gbif, indexfungorum, ipni, level, mobot, mycobank, name, parent, parent_id, parent_name, person, senior, senior_id, valid, zoobank
traits	Trait definitions (GET lists, POST creates).	bibreference, categories, description, export_name, link_type, name, objects, parent, range_max, range_min, tags, type, unit, value_length, wavenumber_max, wavenumber_min
vernaculars	Vernacular names (GET lists, POST creates).	citations, individuals, language, name, notes, parent, taxons, type
vouchers	Voucher specimens (GET lists, POST creates, PUT updates).	biocollection, biocollection_number, biocollection_type, collector, dataset, date, individual, notes, number
datasets	Datasets and published dataset versions (GET lists, POST creates via import job).	description, license, name, privacy, project_id, share_taxon_list, title, visibility
identification-histories	Identification history records (GET lists, POST creates manual history rows).	biocollection_id, biocollection_reference, date, identification_id, identifier, identifier_id, identifiers, individual_id, modifier, notes, replaced_at, source, taxon_id

PUT DATA (updates)

Attention

Only the endpoints listed below can be updated using the API and only the listed PUT fields can be updated on each endpoint. Field values are as explained for the POST API endpoints, except that in all cases you must also provide the id of the record to be updated.

Endpoint	Description	Parameters
individuals	Individuals (GET lists, POST creates, PUT updates).	id, collector, dataset, date, identification_based_on_biocollection, identification_based_on_biocollection_number, identification_date, identification_individual, identification_notes, identifier, individual_id, modifier, notes, tag, taxon
individual-locations	Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).	id, altitude, angle, distance, individual, individual_location_id, latitude, location, location_date_time, location_notes, longitude, x, y
locations	Locations (GET lists, POST creates, PUT updates).	id, adm_level, altitude, datum, geom, ismarine, lat, location_id, long, name, notes, parent, startx, starty, x, y
measurements	Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).	id, bibreference, dataset, date, duplicated, link_id, location, measurement_id, notes, object_id, object_type, parent_measurement, person, trait_id, value
media	Media metadata (GET lists, POST creates, PUT updates).	id, collector, dataset, date, latitude, license, location, longitude, media_id, media_uuid, notes, project, tags, title_en, title_pt
persons	People (GET lists, POST creates, PUT updates).	id, abbreviation, biocollection, email, full_name, institution, person_id
vouchers	Voucher specimens (GET lists, POST creates, PUT updates).	id, biocollection, biocollection_number, biocollection_type, clear_biocollection_number, collector, dataset, date, individual, notes, number, voucher_id
taxons	Taxonomic names (GET lists, POST creates).	id, author, author_id, bibkey, bibreference, bibreference_id, enforceValid, gbif, indexfungorum, ipni, level, mobot, mycobank, name, notes, parent, parent_id, parent_name, person, senior_id, taxon_id, valid, zoobank

Nomenclature types

Nomenclature types numeric codes
NotType : 0	Isosyntype : 8
Type : 1	Neotype : 9
Holotype : 2	Epitype : 10
Isotype : 3	Isoepitype : 11
Paratype : 4	Cultivartype : 12
Lectotype : 5	Clonotype : 13
Isolectotype : 6	Topotype : 14
Syntype : 7	Phototype : 15

Taxonomic ranks

Code	Rank
-100	`clade`
0	`kingdom`
10	`subkingd.`
30	`div., phyl., phylum, division`
40	`subdiv.`
60	`cl., class`
70	`subcl., subclass`
80	`superord., superorder`
90	`ord., order`
100	`subord.`
120	`fam., family`
130	`subfam., subfamily`
150	`tr., tribe`
180	`gen., genus`
190	`subg., subgenus, sect.`
210	`section, sp., spec., species`
220	`subsp., subspecies`
240	`var., variety`
270	`f., fo., form`

2 - GET data

How to get data using the API!

The OpenDataBio-R package is a client for this API.
Query examples in R are here;
No authentication is needed to access data with a public access policy
Authentication token is required only to get data with a non-public access policy

Shared GET parameters

When multiple parameters are specified, they are combined with an AND operator. There is no OR parameter option in searches.

Download large datasets?

wildcards

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`

Selecting response fields

The fields parameter controls the returned columns:

simple is the default profile and contains the fields most useful for common workflows;
all adds detailed, relational, technical, or compatibility fields;
a comma-separated list, such as fields=id,uuid,scientificName, returns only the requested fields.

Each endpoint below includes a table showing membership in simple and all and the meaning of every field. Definitions come from the application schema. Endpoint-specific meanings take precedence over shared definitions—for example, x and y mean different things for Locations and Individuals. Fields marked as Darwin Core follow the exchange vocabulary; fields marked as local are OpenDataBio extensions.

GET endpoints

/ (GET)

Tests your access/token.

No parameters for this endpoint.

bibreferences (GET)

Bibliographic references (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibkey`	No	Bibreference key or list of keys.	`ducke1953,mayr1992`
`biocollection`	No	Biocollection id/name/acronym; returns references cited by vouchers in those collections.	`INPA`
`dataset`	No	Dataset id or name; returns bibreferences linked to the dataset.	`Forest1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search on bibtex using boolean mode; spaces act as AND.	`Amazon forest`
`taxon`	No	Taxon id or canonical name list; matches references linked to the taxon.	`Ocotea guianensis or 120,455`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`bibkey`	`simple` / `all`	OpenDataBio local short key used to identify a bibliographic reference.
`year`	`simple` / `all`	Publication year of a bibliographic reference.
`author`	`simple` / `all`	Author string for a bibliographic reference or taxonomic name, depending on the endpoint.
`title`	`simple` / `all`	Title of a bibliographic reference or dataset, depending on the endpoint.
`doi`	`simple` / `all`	Digital Object Identifier associated with a bibliographic reference.
`url`	`simple` / `all`	URL associated with a bibliographic reference.
`bibtex`	`simple` / `all`	BibTeX representation of the bibliographic reference or media citation.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 2,
            "bibkey": "Riberiroetal1999FloraDucke",
            "year": 1999,
            "author": "José Eduardo Lahoz Da Silva Ribeiro and Michael John Gilbert Hopkins and Alberto Vicentini and Cynthia Anne Sothers and Maria Auxiliadora Da Silva Costa and Joneide Mouzinho De Brito and Maria Anália Duarte De Souza and Lúcia Helena Pinheiro Martins and Lúcia Garcez Lohmann and Paulo Apóstolo Costa Lima Assunção and Everaldo Da Costa Pereira and Cosme Fernandes Da Silva and Mariana Rabello Mesquita and Lilian Costa Procópio",
            "title": "Flora Da Reserva Ducke: Guia De Identificação Das Plantas Vasculares De Uma Floresta De Terra Firme Na Amazônica Central",
            "doi": null,
            "url": null,
            "bibtex": "@Article{Riberiroetal1999FloraDucke,\r\n  title = {Flora da Reserva Ducke: Guia de Identifica{\\c{c}}{\\~a}o das Plantas Vasculares de uma Floresta de Terra Firme na Amaz{\\^o}nica Central},\r\n  author = {José Eduardo Lahoz da Silva Ribeiro and Michael John Gilbert Hopkins and Alberto Vicentini and Cynthia Anne Sothers and Maria Auxiliadora da Silva Costa and Joneide Mouzinho de Brito and Maria Anália Duarte de Souza and Lúcia Helena Pinheiro Martins and Lúcia Garcez Lohmann and Paulo Apóstolo Costa Lima Assunç{ã}o and Everaldo da Costa Pereira and Cosme Fernandes da Silva and Mariana Rabello Mesquita and Lilian Costa Procópio},\r\n  journal = {Flora da Reserva Ducke: Guia de Identifica{\\c{c}}{\\~a}o das Plantas Vasculares de uma Floresta de Terra Firme na Amaz{\\^o}nica Central},\r\n  year = {1999},\r\n  publisher = {INPA-DFID Manaus},\r\n  pages = {819p},\r\n}"
        },
        {
            "id": 3,
            "bibkey": "Sutter2006female",
            "year": 2006,
            "author": "D. Merino Sutter and P. I. Forster and P. K. Endress",
            "title": "Female Flowers And Systematic Position Of Picrodendraceae (Euphorbiaceae S.l., Malpighiales)",
            "doi": "10.1007/s00606-006-0414-0",
            "url": "http://dx.doi.org/10.1007/s00606-006-0414-0",
            "bibtex": "@article{Sutter2006female,\n     author = {D. Merino Sutter and P. I. Forster and P. K. Endress},\n     year = {2006},\n     title = {Female flowers and systematic position of Picrodendraceae (Euphorbiaceae s.l., Malpighiales)},\n     issn = {0378-2697 | 1615-6110},\n     issue = {1-4},\n     url = {http://dx.doi.org/10.1007/s00606-006-0414-0},\n     doi = {10.1007/s00606-006-0414-0},\n     volume = {261},\n     page = {187-215},\n     journal = {Plant Systematics and Evolution},\n     journal_short = {Plant Syst. Evol.},\n     published = {Springer Science and Business Media LLC}\n}"
        }
    ]
}

biocollections (GET)

Biocollections (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`acronym`	No	Biocollection acronym.	`INPA`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`irn`	No	Index Herbariorum IRN for filtering biocollections.	`123456`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`name`	No	Exact biocollection name (string).	`Instituto Nacional de Pesquisas da Amazônia`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`acronym`	`simple` / `all`	OpenDataBio local acronym for a project or biocollection.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`irn`	`simple` / `all`	OpenDataBio local institutional registration number for a biological collection.
`country`	`all`	Country name or code associated with a location.
`city`	`all`	OpenDataBio local city recorded for a biological collection.
`address`	`all`	OpenDataBio local address text recorded for a biocollection.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "acronym": "INPA",
            "name": "Instituto Nacional de Pesquisas da Amazônia",
            "irn": 124921,
            "country": null,
            "city": null,
            "address": null
        },
        {
            "id": 2,
            "acronym": "SPB",
            "name": "Universidade de São Paulo",
            "irn": 126324,
            "country": null,
            "city": null,
            "address": null
        }
    ]
}

datasets (GET)

Datasets and published dataset versions (GET lists, POST creates via import job).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`has_versions`	No	When 1, returns only datasets that have public versions.	`1`
`include_url`	No	When 1 with list_versions, include archive URL.	`1`
`limit`	No	Maximum number of records to return.	`100`
`list_versions`	No	If true, lists dataset version files for given id(s).	`1`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`
`summarize`	No	Dataset id to return content/taxonomic/trait summaries.	`3`
`tag`	No	Individual tag/number/code.	`A-1234`
`tagged_with`	No	Tag ids (comma) or text to filter datasets by tags (supports id list or full-text).	`12,13 or canopy leaf`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`traits`	No	Trait ids list (comma-separated) for filtering datasets.	`12,15`
`version_id`	No	Dataset version id to list or download.	`34`
`version_uuid`	No	Dataset version UUID to list or download.	`550e8400-e29b-41d4-a716-446655440000`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`title`	`simple` / `all`	Title of a bibliographic reference or dataset, depending on the endpoint.
`projectName`	`simple` / `all`	Name or acronym of the project linked to the record or dataset.
`project_id`	`simple` / `all`	Internal numeric identifier of the project linked to the record or dataset.
`project_uuid`	`simple` / `all`	Stable UUID of the project linked to the record or dataset.
`description`	`simple` / `all`	OpenDataBio local descriptive text for the exported resource.
`notes`	`simple` / `all`	OpenDataBio local notes associated with the exported resource.
`contactEmail`	`simple` / `all`	OpenDataBio local contact email configured for the dataset.
`taggedWidth`	`simple` / `all`	OpenDataBio local list of tags associated with a dataset. This legacy field name is kept for API compatibility.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`privacyLevel`	`all`	OpenDataBio local system access level configured for the dataset; this is not a license.
`policy`	`all`	OpenDataBio local full data policy text stored for a dataset.
`measurements_count`	`all`	OpenDataBio local count of measurements linked to the dataset.
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 4,
            "name": "PDBFF-FITO 1ha core plots 1-10cm dbh - TREELETS",
            "title": "Arvoretas (1cm>DAP",
            "projectName": "Projeto Dinâmica Biológica de Fragmentos Florestais (PDBFF-Data)",
            "notes": null,
            "privacyLevel": "Restrito a usuários autorizados",
            "policy": null,
            "description": "Contém o único censo de árvores de pequeno porte 1-10cm de diâmetro nas parcelas de 1ha do PDBFF, em 11 das 69 de parcelas permanentes de 1ha do Programa de Monitoramento de Plantas do PDBFF.",
            "measurements_count": null,
            "contactEmail": "example",
            "taggedWidth": "Parcelas florestais | PDBFF | Fitodemográfico",
            "uuid": "e1d8ce8d-4847-11f0-8e9f-9cb654b86224"
        }
    ]
}

individuals (GET)

Individuals (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`dataset`	No	Dataset id/name, filter records that belong to the dataset informed	`3 or FOREST1`
`date_max`	No	Inclusive end date (YYYY-MM-DD) compared against individual date.	`2024-12-31`
`date_min`	No	Inclusive start date (YYYY-MM-DD) compared against individual date.	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id/name list; matches individuals at those exact locations.	`Parcela 25ha or 55,60`
`location_root`	No	Location id/name; includes descendants of the informed locations.	`Parcela 25ha get subplots in this case`
`odbrequest_id`	No	Request id to filter individuals linked to that ODB request.	`12`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Collector person id/name/email list; filters main/associated collectors.	`Silva, J.B. or 23,10`
`project`	No	Project id/name; matches records whose dataset belongs to the project.	`PDBFF`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`tag`	No	Individual tag/number filter; supports list separated by comma.	`A-123,2001`
`taxon`	No	Taxon id/name list; matches identification taxon only (no descendants).	`Licaria guianensis,Minquartia guianensis or 456,457`
`taxon_root`	No	Taxon id/name list; includes descendants of each taxon.	`Lauraceae,Fabaceae or 10,20`
`trait`	No	Trait id list; only used together with dataset to filter by measurements.	`12,15`
`vernacular`	No	Vernacular id/name list to match linked vernaculars.	`castanha\|12`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`dataset_id`	`simple` / `all`	Internal numeric identifier of the dataset that governs the exported record.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`organismID`	`simple` / `all`	Darwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Darwin Core column: human-readable label for the organism or individual record.
`recordedByMain`	`simple` / `all`	Main collector or observer responsible for the record.
`recordNumber`	`simple` / `all`	Darwin Core column: collector or observer record number.
`eventDate`	`simple` / `all`	Darwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`identificationQualifier`	`simple` / `all`	Darwin Core column: qualifier expressing uncertainty or qualification of the identification.
`identifiedBy`	`simple` / `all`	Darwin Core column: person or people responsible for the taxonomic identification.
`dateIdentified`	`simple` / `all`	Darwin Core column: date when the taxonomic identification was made.
`locationName`	`simple` / `all`	Darwin Core-compatible location label used by OpenDataBio for the location associated with the record.
`locationParentName`	`simple` / `all`	Name of the parent location that contains the record location.
`higherGeography`	`simple` / `all`	Darwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
`decimalLatitude`	`simple` / `all`	Darwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
`decimalLongitude`	`simple` / `all`	Darwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
`x`	`simple` / `all`	OpenDataBio local field for occurrence position: Cartesian X coordinate of the individual within its plot, transect, or parent location.
`y`	`simple` / `all`	OpenDataBio local field for occurrence position: Cartesian Y coordinate of the individual within its plot, transect, or parent location. In transects, sign may indicate side of the transect.
`gx`	`simple` / `all`	OpenDataBio local projected or grid X coordinate for an individual position when available.
`gy`	`simple` / `all`	OpenDataBio local projected or grid Y coordinate for an individual position when available.
`angle`	`simple` / `all`	OpenDataBio local azimuth in degrees from a reference point to an occurrence position.
`distance`	`simple` / `all`	OpenDataBio local distance in meters from a reference point to an occurrence position.
`datasetID`	`simple` / `all`	Darwin Core column: stable identifier of the dataset governing the record, formatted by OpenDataBio as `odb:{installation}:dataset:{uuid}`; includes the dataset UUID and installation prefixes.
`datasetName`	`simple` / `all`	Darwin Core column: name or title of the dataset governing the exported record.
`accessRights`	`simple` / `all`	Darwin Core column: human-readable information about permissions, restrictions, and conditions for using the record, derived from the license and data policy of the dataset governing the record.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`recordedDate`	`all`	OpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in `all` exports for backward compatibility; prefer eventDate for interoperability.
`recordedBy`	`all`	Darwin Core column: collectors or observers associated with the record.
`scientificNameAuthorship`	`all`	Darwin Core taxonomic column: authorship string associated with the scientific name.
`taxon_id`	`all`	Internal numeric identifier of the linked taxonomic name.
`taxon_uuid`	`all`	Stable UUID of the linked taxonomic name.
`identification_id`	`all`	Internal numeric identifier of the taxonomic identification linked to the record.
`identification_uuid`	`all`	Stable UUID of the taxonomic identification linked to the record.
`taxonPublishedStatus`	`all`	Publication status of the taxonomic name used in the identification.
`genus`	`all`	Darwin Core taxonomic column: genus associated with the exported taxon or identified organism.
`identificationRemarks`	`all`	Darwin Core column: notes associated with the taxonomic identification.
`identificationBiocollection`	`all`	Biocollection used as a reference for the identification, when applicable.
`identificationBiocollectionReference`	`all`	Catalog or reference number in the biocollection used for identification.
`location_id`	`all`	Internal numeric identifier of the linked location.
`location_uuid`	`all`	Stable UUID of the linked location.
`georeferenceRemarks`	`all`	Darwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
`relatedLocations`	`all`	Other locations related to the record that may not fit political administrative boundaries, such as Indigeneous Territories, Protected areas and environmental layers stored in the Opendatabio installation
`organismRemarks`	`all`	Darwin Core column: remarks about the organism or individual.
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 306246,
            "basisOfRecord": "Organism",
            "organismID": "2639_Spruce_1852",
            "recordedByMain": "Spruce, R.",
            "recordNumber": "2639",
            "recordedDate": "1852-10",
            "recordedBy": "Spruce, R.",
            "scientificName": "Ecclinusa lanceolata",
            "scientificNameAuthorship": "(Mart. & Eichler) Pierre",
            "taxonPublishedStatus": "published",
            "genus": "Ecclinusa",
            "family": "Sapotaceae",
            "identificationQualifier": "",
            "identifiedBy": "Spruce, R.",
            "dateIdentified": "1852-10-00",
            "identificationRemarks": "",
            "identificationBiocollection": null,
            "identificationBiocollectionReference": null,
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "São Gabriel da Cachoeira < Amazonas < Brasil",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "locationParentName": "Amazonas",
            "x": null,
            "y": null,
            "gx": null,
            "gy": null,
            "angle": null,
            "distance": null,
            "organismRemarks": "prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM",
            "uuid": "c01000f0-f437-11ef-b90b-9cb654b86224"
        }
    ]
}

individual-locations (GET)

Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`dataset`	No	Dataset id/name; filters by dataset of the linked individual.	`FOREST1`
`date_max`	No	Upper bound date/time; compares date_time or individual date when empty.	`2024-12-31`
`date_min`	No	Lower bound date/time; compares date_time or individual date when empty.	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id list whose occurrences will be returned.	`12,44`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Collector person id/name/email list; filters by individual collectors.	`J.Silva\|23`
`project`	No	Project id/name; matches occurrences whose individual belongs to datasets in project.	`PDBFF`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`tag`	No	Individual tag/number list; matches by individuals.tag column	`A-123,B-2`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`individual_id`	`simple` / `all`	Internal numeric identifier of the linked individual or organism record.
`individual_uuid`	`simple` / `all`	Stable UUID of the linked individual or organism record.
`location_id`	`simple` / `all`	Internal numeric identifier of the linked location.
`location_uuid`	`simple` / `all`	Stable UUID of the linked location.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`occurrenceID`	`simple` / `all`	Darwin Core column: stable identifier of the biological occurrence record. In OpenDataBio, an occurrence should represent the presence/record of an organism or taxon at a location.
`organismID`	`simple` / `all`	Darwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Darwin Core column: human-readable label for the organism or individual record.
`eventDate`	`simple` / `all`	Darwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
`locationName`	`simple` / `all`	Darwin Core-compatible location label used by OpenDataBio for the location associated with the record.
`higherGeography`	`simple` / `all`	Darwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
`decimalLatitude`	`simple` / `all`	Darwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
`decimalLongitude`	`simple` / `all`	Darwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
`x`	`simple` / `all`	OpenDataBio local field for occurrence position: Cartesian X coordinate of this individual occurrence within its plot, transect, or parent location.
`y`	`simple` / `all`	OpenDataBio local field for occurrence position: Cartesian Y coordinate of this individual occurrence within its plot, transect, or parent location. In transects, sign may indicate side of the transect.
`angle`	`simple` / `all`	OpenDataBio local azimuth in degrees from a reference point to an occurrence position.
`distance`	`simple` / `all`	OpenDataBio local distance in meters from a reference point to an occurrence position.
`minimumElevation`	`simple` / `all`	Darwin Core column: lower bound of elevation for the occurrence or location, in meters.
`occurrenceRemarks`	`simple` / `all`	Darwin Core column: remarks about the occurrence.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`datasetID`	`simple` / `all`	Darwin Core column: stable identifier of the dataset governing the record, formatted by OpenDataBio as `odb:{installation}:dataset:{uuid}`; includes the dataset UUID and installation prefixes.
`datasetName`	`simple` / `all`	Darwin Core column: name or title of the dataset governing the exported record.
`accessRights`	`simple` / `all`	Darwin Core column: human-readable information about permissions, restrictions, and conditions for using the record, derived from the license and data policy of the dataset governing the record.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`occurrenceName`	`all`	Human-readable label for an occurrence record.
`recordedDate`	`all`	OpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in `all` exports for backward compatibility; prefer eventDate for interoperability.
`georeferenceRemarks`	`all`	Darwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
`organismRemarks`	`all`	Darwin Core column: remarks about the organism or individual.
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 306244,
            "individual_id": 306246,
            "basisOfRecord": "Occurrence",
            "occurrenceID": "2639_Spruce_1852.1852-10",
            "organismID": "2639_Spruce_1852",
            "scientificName": "Ecclinusa lanceolata",
            "family": "Sapotaceae",
            "recordedDate": "1852-10",
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "Brasil > Amazonas > São Gabriel da Cachoeira",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "x": null,
            "y": null,
            "angle": null,
            "distance": null,
            "minimumElevation": null,
            "occurrenceRemarks": null,
            "organismRemarks": "prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM"
        }
    ]
}

languages (GET)

Lists available interface/data languages.

Parameter	Required	Description	Example
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "code": "en",
            "name": "English",
            "is_locale": 1,
            "created_at": null,
            "updated_at": null
        }
    ]
}

locations (GET)

Locations (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`adm_level`	No	One or more adm_level codes	`10,100`
`dataset`	No	Dataset id/name; expands to all locations used by that dataset.	`FOREST1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`lat`	No	Latitude (decimal degrees) used with querytype.	`-3.11`
`limit`	No	Maximum number of records to return.	`100`
`location_root`	No	Alias of root for compatibility.	`Amazonas`
`long`	No	Longitude (decimal degrees) used with querytype.	`-60.02`
`name`	No	Exact name match; accepts list of names or ids.	`Manaus or 10`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`parent_id`	No	Parent id for hierarchical queries.	`210`
`project`	No	Project id or acronym.	`PDBFF or 2`
`querytype`	No	When lat/long are provided: exact\|parent\|closest geometric search.	`parent`
`root`	No	Location id/name; returns it and all descendants and related locations	`Amazonas or "Parque Nacional do Jaú" ...`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Prefix search on name (SQL LIKE name%).	`Mana search for names that starts "mana"`
`taxon`	No	Taxon id/name list; filters locations by linked identifications.	`Euterpe precatoria`
`taxon_root`	No	Taxon id/name list; includes descendants when filtering linked identifications.	`Euterpe - finds alls records that belongs to this genus`
`trait`	No	Trait id/name; only works together with dataset to filter by measurements.	`DBH`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`locationID`	`simple` / `all`	Darwin Core column: stable identifier of the location record, formatted by OpenDataBio as `odb:{installation}:location:{uuid}`.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`locationName`	`simple` / `all`	Darwin Core-compatible location label used by OpenDataBio for the location associated with the record.
`adm_level`	`simple` / `all`	OpenDataBio local administrative level code for a location.
`country_adm_level`	`simple` / `all`	OpenDataBio local administrative level code identifying which location level represents the country.
`x`	`simple` / `all`	OpenDataBio local field for location geometry: X dimension or length of a plot/transect in the location local coordinate system.
`y`	`simple` / `all`	OpenDataBio local field for location geometry: Y dimension of a plot or buffer/width value for a transect in the location local coordinate system.
`startx`	`simple` / `all`	OpenDataBio local starting X coordinate for a plot, transect, or local coordinate system.
`starty`	`simple` / `all`	OpenDataBio local starting Y coordinate for a plot, transect, or local coordinate system.
`distance_to_search`	`simple` / `all`	OpenDataBio local distance, usually in meters, between a location and the search coordinate.
`parent_id`	`simple` / `all`	Internal numeric identifier of the parent record in a hierarchy.
`parent_uuid`	`simple` / `all`	Stable UUID of the parent record in a hierarchy.
`parentName`	`simple` / `all`	OpenDataBio local name of the parent location.
`higherGeography`	`simple` / `all`	Darwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
`footprintWKT`	`simple` / `all`	Darwin Core column: location geometry in WKT format.
`locationRemarks`	`simple` / `all`	Darwin Core column: remarks or notes about the location.
`decimalLatitude`	`simple` / `all`	Darwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
`decimalLongitude`	`simple` / `all`	Darwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
`georeferenceRemarks`	`simple` / `all`	Darwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
`geodeticDatum`	`simple` / `all`	Darwin Core column: spatial datum or coordinate reference system used for the coordinates.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 27297,
            "basisOfRecord": "Location",
            "locationName": "Parcela 1105",
            "adm_level": 100,
            "country_adm_level": "Parcela",
            "x": "100.00",
            "y": "100.00",
            "startx": null,
            "starty": null,
            "distance_to_search": null,
            "parent_id": 27277,
            "parentName": "Fazenda Esteio",
            "higherGeography": "Brasil > Amazonas > Rio Preto da Eva > Fazenda Esteio > Parcela 1105",
            "footprintWKT": "POLYGON((-59.81371985 -2.42215752,-59.81360263 -2.42126619,-59.81270751 -2.42136656,-59.81282469 -2.42225788,-59.81371985 -2.42215752))",
            "locationRemarks": "source: Polígono desenhado a partir das coordenadas de GPS dos vértices; georeferencedBy: Diogo Martins Rosa & Ana Andrade; fundedBy: Edital CNPq-Brasil/LBA 458027/2013-8; geometryBy: Alberto Vicentini; geometryDate: 2021-09-29; warning: Conflito com polígono da UC de 2021. Este polígono deveria ter a mesma geometria do polígono correspondente que faz parte da UC ARIE PDBFF, mas como ele foi gerado pelas coordenadas de campo, foi mantida essa geometria. A UC, portanto, não protege adequadamente essa parcela de monitoramento.",
            "decimalLatitude": -2.42215752,
            "decimalLongitude": -59.81371985,
            "georeferenceRemarks": "decimal coordinates are the START POINT in footprintWKT geometry",
            "geodeticDatum": null
        }
    ]
}

measurements (GET)

Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date_max`	No	Filter records occurring on/before this date (YYYY-MM-DD).	`2024-12-31`
`date_min`	No	Filter records occurring on/after this date (YYYY-MM-DD).	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`measured_id`	No	Measurement filter: id of the measured object (matches measured_type).	`4521`
`measured_type`	No	Measurement filter: class name of measured object (Individual, Location, Taxon, Voucher, Media).	`Media`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`trait`	No	Trait id or export_name filter.	`DBH`
`trait_type`	No	Filter measurements by trait type code.	`1`
`voucher`	No	Voucher id for filtering measurements.	`102`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`measurementID`	`simple` / `all`	Darwin Core column: stable identifier of the measurement record, formatted by OpenDataBio as `odb:{installation}:measurement:{uuid}`.
`dataset_id`	`simple` / `all`	Internal numeric identifier of the dataset that governs the exported record.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`measured_type`	`simple` / `all`	OpenDataBio local model type of the object measured by a measurement record.
`measured_id`	`simple` / `all`	Internal numeric identifier of the object measured by a measurement record.
`measured_uuid`	`simple` / `all`	Stable UUID of the object measured by a measurement record, when the object has a UUID.
`trait_id`	`simple` / `all`	Internal numeric identifier of the linked trait.
`trait_uuid`	`simple` / `all`	Stable UUID of the linked trait.
`measurementType`	`simple` / `all`	Darwin Core MeasurementOrFact column: trait export name or measurement type represented by the measurement.
`measurementValue`	`simple` / `all`	Darwin Core MeasurementOrFact column: recorded value of the measurement.
`measurementUnit`	`simple` / `all`	Darwin Core MeasurementOrFact column: unit associated with the measurement value.
`measurementDeterminedBy`	`simple` / `all`	Darwin Core MeasurementOrFact column: person or people who determined or recorded the measurement.
`measurementDeterminedDate`	`simple` / `all`	Darwin Core MeasurementOrFact column: date when the measurement was determined or recorded.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`datasetID`	`simple` / `all`	Darwin Core column: stable identifier of the dataset governing the record, formatted by OpenDataBio as `odb:{installation}:dataset:{uuid}`; includes the dataset UUID and installation prefixes.
`datasetName`	`simple` / `all`	Darwin Core column: name or title of the dataset governing the exported record.
`sourceCitation`	`simple` / `all`	Citation for the source from which the record or measurement was derived.
`accessRights`	`simple` / `all`	Darwin Core column: human-readable information about permissions, restrictions, and conditions for using the record, derived from the license and data policy of the dataset governing the record.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`dataset_uuid`	`all`	Stable UUID of the dataset that governs the exported record.
`measurementRemarks`	`all`	Darwin Core MeasurementOrFact column: notes associated with the measurement.
`resourceRelationship`	`all`	Darwin Core ResourceRelationship column: type of relationship between the exported record and the resource it is linked to.
`resourceRelationshipID`	`all`	Darwin Core relationship column: stable identifier of the related OpenDataBio resource, formatted as `odb:{installation}:{type}:{uuid}` when the related object has a stable identifier.
`resourceRelationshipName`	`all`	Darwin Core ResourceRelationship-compatible column: human-readable name of the related resource.
`relationshipOfResource`	`all`	Darwin Core relationshipOfResource value describing how the resource is related.
`measurementMethod`	`all`	Darwin Core MeasurementOrFact column: method or protocol used to obtain the measurement, i.e. trait definition and metadata
`bibreference_id`	`all`	Internal numeric identifier of the linked bibliographic reference.
`bibreference_uuid`	`all`	Stable UUID of the linked bibliographic reference.
`measurementLocationId`	`all`	Internal numeric identifier of the location associated with the measurement.
`measurementLocationUuid`	`all`	Stable UUID of the location associated with the measurement.
`measurementParentId`	`all`	Internal numeric identifier of the parent measurement when this measurement is nested.
`measurementParentUuid`	`all`	Stable UUID of the parent measurement when this measurement is nested.
`decimalLatitude`	`all`	Darwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
`decimalLongitude`	`all`	Darwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 853443,
            "basisOfRecord": "MeasurementsOrFact",
            "measured_type": "App\\Models\\Voucher",
            "measured_id": 1519,
            "measurementType": "HasSilica",
            "measurementValue": "Sim",
            "measurementUnit": null,
            "measurementDeterminedDate": "2014-09-24",
            "measurementDeterminedBy": "Equipe FITO",
            "measurementRemarks": null,
            "resourceRelationship": null,
            "resourceRelationshipID": "3304.8846.Equipe-FITO.PDBFF.PDBFF005425",
            "relationshipOfResource": "measurement of",
            "scientificName": "Pouteria fimbriata",
            "family": "Sapotaceae",
            "datasetName": "SILICOTECA",
            "measurementMethod": "Name: Has sílica-gel sample for DNA extraction | Definition:Has a tissue preserved in sílica-gel for DNA extractions. | Categories: CategoryName: Yes | Definition:Has an associated sample in sílica-gel.",
            "sourceCitation": null,
            "measurementLocationId": 29639,
            "measurementParentId": null,
            "decimalLatitude": -2.36495453,
            "decimalLongitude": -59.97365135
        }
    ]
}

media (GET)

Media metadata (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`media_id`	No	Media numeric id.	`88`
`media_uuid`	No	Media UUID.	`a3f0a4ac-6b5b-11ed-b8c0-0242ac120002`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`tag`	No	Individual tag/number/code.	`A-1234`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`uuid`	No		—
`voucher`	No	Voucher id for filtering measurements.	`102`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`model_type`	`simple` / `all`	OpenDataBio local model class of the object linked to a media record.
`model_id`	`simple` / `all`	Internal numeric identifier of the OpenDataBio object linked to a media record.
`model_uuid`	`simple` / `all`	Stable UUID of the OpenDataBio object linked to a media record.
`dataset_id`	`simple` / `all`	Internal numeric identifier of the dataset that governs the exported record.
`dataset_uuid`	`simple` / `all`	Stable UUID of the dataset that governs the exported record.
`project_id`	`simple` / `all`	Internal numeric identifier of the project linked to the record or dataset.
`project_uuid`	`simple` / `all`	Stable UUID of the project linked to the record or dataset.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`recordedBy`	`simple` / `all`	Darwin Core column: collectors or observers associated with the record.
`eventDate`	`simple` / `all`	Darwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
`dwcType`	`simple` / `all`	Darwin Core / Dublin Core type value of the media or linked resource.
`resourceRelationship`	`simple` / `all`	Darwin Core ResourceRelationship column: type of relationship between the exported record and the resource it is linked to.
`resourceRelationshipID`	`simple` / `all`	Darwin Core relationship column: stable identifier of the related OpenDataBio resource, formatted as `odb:{installation}:{type}:{uuid}` when the related object has a stable identifier.
`resourceRelationshipName`	`simple` / `all`	Darwin Core ResourceRelationship-compatible column: human-readable name of the related resource.
`relationshipOfResource`	`simple` / `all`	Darwin Core relationshipOfResource value describing how the resource is related.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`datasetID`	`simple` / `all`	Darwin Core column: stable identifier of the dataset governing the record, formatted by OpenDataBio as `odb:{installation}:dataset:{uuid}`; includes the dataset UUID and installation prefixes.
`datasetName`	`simple` / `all`	Darwin Core column: name or title of the dataset governing the exported record.
`projectName`	`simple` / `all`	Name or acronym of the project linked to the record or dataset.
`taggedWith`	`simple` / `all`	Tags or keywords associated with the record.
`accessRights`	`simple` / `all`	Darwin Core column: human-readable information about permissions, restrictions, and conditions for using the record, derived from the license and data policy of the dataset governing the record.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`license`	`simple` / `all`	License assigned to the media file or dataset resource.
`file_name`	`simple` / `all`	Stored file name for a media object or downloadable dataset file.
`file_url`	`simple` / `all`	Public URL for retrieving the media file or downloadable file.
`citation`	`simple` / `all`	Human-readable citation associated with the record or media file.
`recordedDate`	`all`	OpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in `all` exports for backward compatibility; prefer eventDate for interoperability.
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.
`bibliographicCitation`	`all`	Darwin Core / Dublin Core column: formatted bibliographic citation associated with the record.
`bibtex`	`all`	BibTeX representation of the bibliographic reference or media citation.
`userName`	`all`	Name of the OpenDataBio user associated with the record action.
`created_at`	`all`	Timestamp when the record was created in OpenDataBio.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 20211,
            "model_type": "App\\Models\\Individual",
            "model_id": 111785,
            "basisOfRecord": "MachineObservation",
            "recordedBy": "Francisco Javier Farroñay Pacaya",
            "recordedDate": "2025-03-09",
            "dwcType": "StillImage",
            "resourceRelationship": "Organism",
            "resourceRelationshipID": "3402-1134_Pereira_1986",
            "relationshipOfResource": "StillImage of ",
            "scientificName": "Sacoglottis guianensis",
            "family": "Humiriaceae",
            "datasetName": "Unknown dataset",
            "projectName": "Projeto Dinâmica Biológica de Fragmentos Florestais",
            "taggedWith": "Folha abaxial",
            "accessRights": "Open access.",
            "bibliographicCitation": "Sacoglottis guianensis (Humiriaceae). (2025). By Francisco Javier Farroñay Pacaya. Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF). Project: PDBFF-Data. Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil. Type: Image. License: CC-BY-NC-SA 4.0. uuid: inpa-odb-3f139ba4-f22b-42d8-9e74-c340309061c2, url: http://localhost/opendatabio",
            "license": "CC-BY-NC-SA 4.0",
            "file_name": "67ce28cd76f4a.jpg",
            "file_url": "http://localhost/opendatabio/storage/media/20211/67ce28cd76f4a.jpg",
            "citation": "Sacoglottis guianensis (Humiriaceae). (2025). By Francisco Javier Farroñay Pacaya. Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF). Project: PDBFF-Data. Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil. Type: Image. License: CC-BY-NC-SA 4.0. uuid: inpa-odb-3f139ba4-f22b-42d8-9e74-c340309061c2, url: http://localhost/opendatabio",
            "uuid": "3f139ba4-f22b-42d8-9e74-c340309061c2",
            "bibtex": "@misc{Farronay_2025_20211,\n{\n    \"title\": \" Sacoglottis guianensis (Humiriaceae)\",\n    \"year\": \"(2025)\",\n    \"author\": \"Francisco Javier Farroñay Pacaya\",\n    \"howpublished\": \"{http:\\/\\/localhost\\/opendatabio\\/media\\/uuid\\/3f139ba4-f22b-42d8-9e74-c340309061c2}\",\n    \"license\": \"CC-BY-NC-SA 4.0\",\n    \"note\": \"Type: Image; Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF); Coordinates: POINT(-59.91500315727877 -2.3929141688648765); License: CC-BY-NC-SA 4.0; Project: PDBFF-Data.; Accessed: 2026-02-04\",\n    \"publisher\": \"Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil\"\n}\n}",
            "userName": "example",
            "created_at": "2025-03-09T23:48:29.000000Z"
        }
    ]
}

persons (GET)

People (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`abbrev`	No	Abbreviation search for persons.	`Silva, J.B, Pilco, M.V.`
`email`	No	Email address.	`user@example.org`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`full_name`	`simple` / `all`	OpenDataBio local full name of a person.
`abbreviation`	`simple` / `all`	OpenDataBio local abbreviation for a person or biocollection.
`emailAddress`	`simple` / `all`	OpenDataBio local person email address when it is available for export.
`institution`	`simple` / `all`	OpenDataBio local institution associated with a person.
`orcid`	`simple` / `all`	ORCID identifier associated with a person.
`notes`	`simple` / `all`	OpenDataBio local notes associated with the exported resource.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 3127,
            "full_name": "Raimundo Afeganistão",
            "abbreviation": "AFEGANISTÃO, R.",
            "emailAddress": null,
            "institution": null,
            "notes": "PDBFF"
        },
        {
            "id": 14,
            "full_name": "Maria de Fátima  Agra",
            "abbreviation": "Agra, M.F.",
            "emailAddress": null,
            "institution": null,
            "notes": null
        },
        {
            "id": 15,
            "full_name": "J. L. A. Aguiar Jr",
            "abbreviation": "Aguiar Jr., J.L.A.",
            "emailAddress": null,
            "institution": null,
            "notes": null
        }
    ]
}

projects (GET)

Projects (GET lists).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`
`tag`	No	Individual tag/number/code.	`A-1234`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`acronym`	`simple` / `all`	OpenDataBio local acronym for a project or biocollection.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`description`	`simple` / `all`	OpenDataBio local descriptive text for the exported resource.
`pages`	`all`	OpenDataBio local project pages metadata.
`urls`	`all`	OpenDataBio local list of URLs associated with a project.
`created_at`	`all`	Timestamp when the record was created in OpenDataBio.
`updated_at`	`all`	Timestamp when the record was last updated in OpenDataBio.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "acronym": "PDBFF-Data",
            "name": "Projeto Dinâmica Biológica de Fragmentos Florestais",
            "description": "Este espaço agrega conjuntos de dados de monitoramentos e pesquisas realizadas nas áreas amostrais do PDBFF,  localizadas na Área de Relevante Interesse Ecológico - ARIE PDBFF.",
            "pages": {
                "en": null,
                "pt-br": null
            },
            "urls": [
                {
                    "url": "https://alfa-pdbff.site/",
                    "label": null,
                    "icon": "fa-solid fa-globe"
                }
            ],
            "created_at": "2022-10-31T07:01:18.000000Z",
            "updated_at": "2023-11-17T21:08:55.000000Z"
        }
    ]
}

taxons (GET)

Taxonomic names (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`external`	No	Flag to include external ids (Tropicos, IPNI, etc.).	`1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`level`	No	Taxon rank code or string.	`210 or species`
`limit`	No	Maximum number of records to return.	`100`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`project`	No	Project id or acronym.	`PDBFF or 2`
`root`	No	Root id for hierarchical queries (taxon or location).	`120`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`trait`	No	Trait id or export_name filter.	`DBH`
`valid`	No	When 1, return only valid taxon names.	`1`
`vernacular`	No	Vernacular id or name list used to filter individuals.	`castanha\|12`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`scientificNameID`	`simple` / `all`	Darwin Core taxonomic column: stable identifier of the taxonomic name record, formatted by OpenDataBio as `odb:{installation}:taxon:{uuid}`.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`taxonRank`	`simple` / `all`	Darwin Core taxonomic column: taxonomic rank of the scientific name.
`scientificNameAuthorship`	`simple` / `all`	Darwin Core taxonomic column: authorship string associated with the scientific name.
`namePublishedIn`	`simple` / `all`	Darwin Core taxonomic column: bibliographic reference in which the taxonomic name was published.
`parentNameUsageID`	`simple` / `all`	Darwin Core taxonomic column: stable identifier of the parent taxon, formatted by OpenDataBio as `odb:{installation}:taxon:{uuid}`.
`parentNameUsage`	`simple` / `all`	Darwin Core taxonomic column: parent taxon name in the taxonomic hierarchy.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`higherClassification`	`simple` / `all`	Darwin Core taxonomic column: higher taxonomic classification path for the taxon.
`taxonRemarks`	`simple` / `all`	Darwin Core taxonomic column: remarks about the taxon.
`taxonomicStatus`	`simple` / `all`	Darwin Core taxonomic column: taxonomic status of the name, such as accepted name or synonym.
`acceptedNameUsage`	`simple` / `all`	Darwin Core taxonomic column: accepted scientific name when the exported name is not accepted.
`acceptedNameUsageID`	`simple` / `all`	Darwin Core taxonomic column: stable identifier of the accepted taxonomic name, formatted by OpenDataBio as `odb:{installation}:taxon:{uuid}`.
`author_uuid`	`all`	Stable UUID of the person linked as author of an unpublished taxonomic name.
`bibreference_uuid`	`all`	Stable UUID of the linked bibliographic reference.
`parent_id`	`all`	Internal numeric identifier of the parent record in a hierarchy.
`parent_uuid`	`all`	Stable UUID of the parent record in a hierarchy.
`senior_id`	`all`	Internal numeric identifier of the accepted or senior taxonomic name.
`externalKeys`	`all`	OpenDataBio local external database identifiers linked to a taxonomic name.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 16332,
            "senior_id": null,
            "parent_id": 16331,
            "author_id": null,
            "scientificName": "Aiouea grandifolia",
            "taxonRank": "Species",
            "scientificNameAuthorship": "van der Werff",
            "namePublishedIn": null,
            "parentName": "Aiouea",
            "family": "Lauraceae",
            "higherClassification": "Eukaryota > Plantae > Viridiplantae > Embryophytes > Spermatopsida > Angiosperms > Magnoliidae > Laurales > Lauraceae > Aiouea",
            "taxonRemarks": null,
            "taxonomicStatus": "accepted",
            "acceptedNameUsage": null,
            "acceptedNameUsageID": null,
            "parentNameUsage": "Aiouea",
            "scientificNameID": "https://tropicos.org/Name/17806050 | https://www.gbif.org/species/4175896",
            "basisOfRecord": "Taxon"
        }
    ]
}

traits (GET)

Trait definitions (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`categories`	No	Trait categories JSON list with lang/rank/name/description.	`[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`language`	No	Language id/code/name. For POST vernaculars, registered languages are accepted; absent languages are created from config/languagesISO6393.php only when the informed value matches an ISO639-3 code or configured language name, with is_locale=0.	`en or 1 or english or spa`
`limit`	No	Maximum number of records to return.	`100`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`object_type`	No	Measured object type: Individual, Location, Taxon, Voucher, or Media.	`Individual`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`
`tag`	No	Individual tag/number/code.	`A-1234`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`trait`	No	Trait id or export_name filter.	`DBH`
`type`	No	Generic type parameter (trait type code or vernacular type such as use/generic/etimology).	`use or 10`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`parent_id`	`simple` / `all`	Internal numeric identifier of the parent record in a hierarchy.
`parent_uuid`	`simple` / `all`	Stable UUID of the parent record in a hierarchy.
`type`	`simple` / `all`	OpenDataBio local type code or type label of the exported resource.
`typename`	`simple` / `all`	OpenDataBio local human-readable name of a trait type.
`export_name`	`simple` / `all`	OpenDataBio local stable export name of a trait, used as a public field key in measurements.
`unit`	`simple`	OpenDataBio local measurement unit configured for a trait.
`range_min`	`simple` / `all`	OpenDataBio local minimum valid value configured for a quantitative trait.
`range_max`	`simple` / `all`	OpenDataBio local maximum valid value configured for a quantitative trait.
`link_type`	`simple` / `all`	OpenDataBio local target object type allowed for a link trait.
`value_length`	`simple` / `all`	OpenDataBio local number of values expected for a spectral trait.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`description`	`simple` / `all`	OpenDataBio local descriptive text for the exported resource.
`objects`	`simple` / `all`	OpenDataBio local list of object types to which a trait can apply.
`measurementType`	`simple` / `all`	Darwin Core MeasurementOrFact column: trait export name or measurement type represented by the measurement.
`categories`	`simple` / `all`	OpenDataBio local list of trait categories, including labels and descriptions when available.
`bibreference_id`	`all`	Internal numeric identifier of the linked bibliographic reference.
`bibreference_uuid`	`all`	Stable UUID of the linked bibliographic reference.
`measurementUnit`	`all`	Darwin Core MeasurementOrFact column: unit associated with the measurement value.
`measurementMethod`	`all`	Darwin Core MeasurementOrFact column: method or protocol used to obtain the measurement, i.e. trait definition and metadata
`MeasurementTypeBibkeys`	`all`	OpenDataBio local list of bibliographic keys that support the trait measurement type.
`TaggedWith`	`all`	OpenDataBio local list of tags associated with a trait.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 206,
            "type": 1,
            "typename": "QUANT_REAL",
            "export_name": "treeDbh",
            "measurementType": "treeDbh",
            "measurementUnit": "cm",
            "range_min": 0.1,
            "range_max": 700,
            "link_type": null,
            "value_length": null,
            "name": "Diâmetro à altura do peito – DAP",
            "description": "Diâmetro à altura do peito, i.e. medido a ca. 1.3m desde a base do caule",
            "objects": "App\\Models\\Individual | App\\Models\\Voucher | App\\Models\\Location | App\\Models\\Taxon | App\\Models\\Media",
            "measurementMethod": "Name: Diameter at breast height - DBH | Definition:Diameter at breast height,, i.e. ca. 1.3 meters from the base of the trunk",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": null
        },
        {
            "id": 207,
            "type": 1,
            "typename": "QUANT_REAL",
            "export_name": "treeDbhPom",
            "measurementType": "treeDbhPom",
            "measurementUnit": "m",
            "range_min": 0,
            "range_max": 15,
            "link_type": null,
            "value_length": null,
            "name": "Ponto de medição do DAP",
            "description": "Ponto de medição do DAP, necessário quando impossível medir a 1.3 m",
            "objects": "App\\Models\\Individual",
            "measurementMethod": "Name: DBH Point of Measurement | Definition:DAP measuring height, necessary when impossible to measure at 1.3 m",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": null
        },
        {
            "id": 524,
            "type": 2,
            "typename": "CATEGORICAL",
            "export_name": "stemType",
            "measurementType": "stemType",
            "measurementUnit": null,
            "range_min": null,
            "range_max": null,
            "link_type": null,
            "value_length": null,
            "name": "Tipo de fuste",
            "description": "Tipo de fuste",
            "objects": "App\\Models\\Voucher | App\\Models\\Individual | App\\Models\\Taxon",
            "measurementMethod": "Name: Type of stem | Definition:Type of stem | Categories: CategoryName: Main stem | Definition:The main trunk, usually the thickest. | CategoryName: Secondary stem | Definition:A secondary trunk, there is a thicker one, which defines the area better. A shoot below 1.3 m high is a secondary trunk.",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": [
                {
                    "id": 12990,
                    "name": "Fuste principal",
                    "description": "O tronco principal, geralmente o mais grosso.",
                    "rank": 1,
                    "belongs_to_trait": "stemType"
                },
                {
                    "id": 12991,
                    "name": "Fuste secundário",
                    "description": "Um tronco secundário, há outro mais grosso, que define melhor a área. Um rebroto abaixo de 1.3 m de altura é um tronco secundário.",
                    "rank": 2,
                    "belongs_to_trait": "stemType"
                }
            ]
        }
    ]
}

vernaculars (GET)

Vernacular names (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`languageName`	`simple` / `all`	OpenDataBio local language name associated with a vernacular name.
`notes`	`simple` / `all`	OpenDataBio local notes associated with the exported resource.
`locationsList`	`simple` / `all`	OpenDataBio local human-readable list of locations linked to the record.
`taxonsList`	`simple` / `all`	OpenDataBio local human-readable list of taxa linked to the record.
`individualsList`	`simple` / `all`	OpenDataBio local human-readable list of individuals linked to the record.
`citationsArray`	`simple` / `all`	OpenDataBio local structured list of citations linked to a vernacular name.
`languageCode`	`all`	OpenDataBio local language code associated with a vernacular name.
`taxonsListArray`	`all`	OpenDataBio local structured array of taxa linked to the record.
`individualsListArray`	`all`	OpenDataBio local structured array of individuals linked to the record.
`locationsListArray`	`all`	OpenDataBio local structured array of locations linked to the record.
`variantsList`	`all`	OpenDataBio local human-readable list of vernacular variants linked to the record.
`variantsListArray`	`all`	OpenDataBio local structured array of vernacular variants linked to the record.
`createdBy`	`all`	OpenDataBio local user or person who created the record.
`created_at`	`all`	Timestamp when the record was created in OpenDataBio.
`updated_at`	`all`	Timestamp when the record was last updated in OpenDataBio.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": []
}

vouchers (GET)

Voucher specimens (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`bibreference_id`	No	BibReference id list for voucher filtering.	`10,11`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`biocollection_id`	No	Biocollection id list for voucher filtering.	`1,5`
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date_max`	No	Filter records occurring on/before this date (YYYY-MM-DD).	`2024-12-31`
`date_min`	No	Filter records occurring on/after this date (YYYY-MM-DD).	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`main_collector`	No	Boolean (1) to filter vouchers by main collector only.	`1`
`number`	No	Collector number/code (voucher/individual tag when different from individual).	`1234A`
`odbrequest_id`	No	Filter individuals linked to a given request id.	`12`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`trait`	No	Trait id or export_name filter.	`DBH`
`vernacular`	No	Vernacular id or name list used to filter individuals.	`castanha\|12`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`uuid`	`simple` / `all`	Stable UUID of the exported record.
`individual_uuid`	`simple` / `all`	Stable UUID of the linked individual or organism record.
`basisOfRecord`	`simple` / `all`	Darwin Core column: basisOfRecord value indicating the general type of biological record.
`occurrenceID`	`simple` / `all`	Darwin Core column: stable identifier of the biological occurrence record. In OpenDataBio, an occurrence should represent the presence/record of an organism or taxon at a location.
`organismID`	`simple` / `all`	Darwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Darwin Core column: human-readable label for the organism or individual record.
`materialEntityID`	`simple` / `all`	Darwin Core column: stable identifier of the physical material entity. In OpenDataBio voucher exports, this is the voucher stable identifier formatted as `odb:{installation}:voucher:{uuid}`.
`collectionCode`	`simple` / `all`	Darwin Core column: code, acronym, or name identifying the biological collection.
`catalogNumber`	`simple` / `all`	Darwin Core column: catalog number or accession number of the voucher in the biological collection.
`typeStatus`	`simple` / `all`	Darwin Core column: nomenclatural type status of a voucher specimen.
`recordedByMain`	`simple` / `all`	Main collector or observer responsible for the record.
`recordNumber`	`simple` / `all`	Darwin Core column: collector or observer record number.
`eventDate`	`simple` / `all`	Darwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
`recordedBy`	`simple` / `all`	Darwin Core column: collectors or observers associated with the record.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`identificationQualifier`	`simple` / `all`	Darwin Core column: qualifier expressing uncertainty or qualification of the identification.
`identifiedBy`	`simple` / `all`	Darwin Core column: person or people responsible for the taxonomic identification.
`dateIdentified`	`simple` / `all`	Darwin Core column: date when the taxonomic identification was made.
`identificationRemarks`	`simple` / `all`	Darwin Core column: notes associated with the taxonomic identification.
`location_id`	`simple` / `all`	Internal numeric identifier of the linked location.
`location_uuid`	`simple` / `all`	Stable UUID of the linked location.
`locationName`	`simple` / `all`	Darwin Core-compatible location label used by OpenDataBio for the location associated with the record.
`higherGeography`	`simple` / `all`	Darwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
`decimalLatitude`	`simple` / `all`	Darwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
`decimalLongitude`	`simple` / `all`	Darwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
`occurrenceRemarks`	`simple` / `all`	Darwin Core column: remarks about the occurrence.
`datasetID`	`simple` / `all`	Darwin Core column: stable identifier of the dataset governing the record, formatted by OpenDataBio as `odb:{installation}:dataset:{uuid}`; includes the dataset UUID and installation prefixes.
`datasetName`	`simple` / `all`	Darwin Core column: name or title of the dataset governing the exported record.
`accessRights`	`simple` / `all`	Darwin Core column: human-readable information about permissions, restrictions, and conditions for using the record, derived from the license and data policy of the dataset governing the record.
`policyCode`	`simple` / `all`	Compact policy code derived from the dataset license and data-use obligations.
`dataset_id`	`all`	Internal numeric identifier of the dataset that governs the exported record.
`individual_id`	`all`	Internal numeric identifier of the linked individual or organism record.
`recordedDate`	`all`	OpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in `all` exports for backward compatibility; prefer eventDate for interoperability.
`scientificNameAuthorship`	`all`	Darwin Core taxonomic column: authorship string associated with the scientific name.
`taxon_id`	`all`	Internal numeric identifier of the linked taxonomic name.
`taxon_uuid`	`all`	Stable UUID of the linked taxonomic name.
`identification_id`	`all`	Internal numeric identifier of the taxonomic identification linked to the record.
`identification_uuid`	`all`	Stable UUID of the taxonomic identification linked to the record.
`taxonPublishedStatus`	`all`	Publication status of the taxonomic name used in the identification.
`genus`	`all`	Darwin Core taxonomic column: genus associated with the exported taxon or identified organism.
`georeferenceRemarks`	`all`	Darwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
`relatedLocations`	`all`	Other locations related to the record that may not fit political administrative boundaries, such as Indigeneous Territories, Protected areas and environmental layers stored in the Opendatabio installation
`policyUrl`	`all`	URL where the full dataset policy can be read for the governing dataset or version.
`policySummary`	`all`	Short plain-language summary of the data-use permissions and obligations.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 72209,
            "individual_id": 306246,
            "basisOfRecord": "PreservedSpecimens",
            "occurrenceID": "2639.Spruce.K.K000640463",
            "organismID": "2639_Spruce_1852",
            "collectionCode": "K",
            "catalogNumber": "K000640463",
            "typeStatus": "Tipo",
            "recordedByMain": "Spruce, R.",
            "recordNumber": "2639",
            "recordedDate": "1852-10",
            "recordedBy": "Spruce, R.",
            "scientificName": "Ecclinusa lanceolata",
            "scientificNameAuthorship": "(Mart. & Eichler) Pierre",
            "taxonPublishedStatus": "published",
            "genus": "Ecclinusa",
            "family": "Sapotaceae",
            "identificationQualifier": "",
            "identifiedBy": "Spruce, R.",
            "dateIdentified": "1852-10-00",
            "identificationRemarks": "",
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "Brasil > Amazonas > São Gabriel da Cachoeira",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "occurrenceRemarks": "OrganismRemarks = prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM",
            "uuid": "6302316f-2b48-43b5-816b-005df70d15c9"
        }
    ]
}

userjobs (GET)

Background jobs (imports/exports) (GET lists).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`get_file`	No	When 1 and used with userjobs id, returns job prepared file.	`1`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`status`	No	Job status filter (Submitted, Processing, Success, Failed, Cancelled).	`Success`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`dispatcher`	`simple` / `all`	OpenDataBio local job dispatcher class or job type.
`status`	`simple` / `all`	OpenDataBio local status of a background job or exported resource.
`percentage`	`simple` / `all`	OpenDataBio local progress percentage for a background job.
`created_at`	`simple` / `all`	Timestamp when the record was created in OpenDataBio.
`affected_ids_count`	`simple` / `all`	OpenDataBio local count of records affected by a background job.
`affected_model`	`simple` / `all`	OpenDataBio local model class or model name affected by a background job.
`updated_at`	`all`	Timestamp when the record was last updated in OpenDataBio.
`affected_ids`	`all`	OpenDataBio local list of record ids affected by a background job.
`log`	`all`	OpenDataBio local text log produced by a background job.

Response example

{
    "message": "Unauthenticated",
    "0": 401
}

activities (GET)

Lists activity log entries.

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`description`	No	Translatable description text. Accepts a plain string or a JSON map of language codes to descriptions.	`{"en":"Tree height at breast height","pt-br":"Altura da árvore à altura do peito"}`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`language`	No	Language id/code/name. For POST vernaculars, registered languages are accepted; absent languages are created from config/languagesISO6393.php only when the informed value matches an ISO639-3 code or configured language name, with is_locale=0.	`en or 1 or english or spa`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`log_name`	No	Activity log name filter.	`default`
`measurement`	No	Activity filter: measurement id.	`55`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`subject`	No	Activity filter: subject type (class basename).	`Individual`
`subject_id`	No	Activity filter: subject id.	`12`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`voucher`	No	Voucher id for filtering measurements.	`102`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`log_name`	`simple` / `all`	OpenDataBio local activity log name.
`description`	`simple` / `all`	OpenDataBio local descriptive text for the exported resource.
`subject_type`	`simple` / `all`	OpenDataBio local model class of the object recorded in an activity log entry.
`subject_name`	`simple` / `all`	OpenDataBio local human-readable name of the object recorded in an activity log entry.
`subject_id`	`simple` / `all`	Internal numeric identifier of the object recorded in an activity log entry.
`modified_by`	`simple` / `all`	OpenDataBio local user who modified the activity subject.
`properties`	`simple` / `all`	OpenDataBio local structured activity properties, usually encoded as JSON.
`created_at`	`simple` / `all`	Timestamp when the record was created in OpenDataBio.
`updated_at`	`simple` / `all`	Timestamp when the record was last updated in OpenDataBio.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "field_key": "taxon_id",
            "field": "Taxon",
            "old_value": "Burseraceae",
            "new_value": "Protium hebetatum forma.b.fito",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "person_id",
            "field": "Person",
            "old_value": "Macedo, M.T.S",
            "new_value": "Pilco, M.V.",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "notes",
            "field": "Notes",
            "old_value": "Identificação feita em campo, anotada na planilha de dados.",
            "new_value": null,
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "date",
            "field": "Date",
            "old_value": "2022-06-17",
            "new_value": "2022-11-23",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        }
    ]
}

tags (GET)

Tags/keywords (GET lists).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`language`	No	Language id/code/name. For POST vernaculars, registered languages are accepted; absent languages are created from config/languagesISO6393.php only when the informed value matches an ISO639-3 code or configured language name, with is_locale=0.	`en or 1 or english or spa`
`limit`	No	Maximum number of records to return.	`100`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`search`	No	Full-text search parameter.	`Silva`
`trait`	No	Trait id or export_name filter.	`DBH`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`name`	`simple` / `all`	OpenDataBio local name of the exported resource.
`description`	`simple` / `all`	OpenDataBio local descriptive text for the exported resource.
`counts`	`all`	OpenDataBio local summary counts associated with a tag.

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 11,
            "name": "Folhas adaxial",
            "description": "Images of the adaxial surface of leaves",
            "counts": {
                "Media": 1852,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        },
        {
            "id": 12,
            "name": "Folha forma",
            "description": "Imagem mostrando uma folha ou o formato da folha.",
            "counts": {
                "Media": 713,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        },
        {
            "id": 13,
            "name": "Frutos",
            "description": "Imagens com frutos",
            "counts": {
                "Media": 2595,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        }
    ]
}

brahms (GET)

BRAHMS/INPA formatted individual export (GET lists, queued export with save_job).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`brahms_level`	No	BRAHMS export level. Use individual for one row per individual, or voucher for one row per voucher linked to matching individuals.	`individual or voucher`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date_max`	No	Filter records occurring on/before this date (YYYY-MM-DD).	`2024-12-31`
`date_min`	No	Filter records occurring on/after this date (YYYY-MM-DD).	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`habitattxt_traits`	No	Measurement trait id/export_name or JSON note key list for BRAHMS habitattxt. JSON keys are searched in individual and individual-location notes; measurements are searched on individual and current location. Use all or none.	`all or soil_type,canopy_opening or none`
`habitattxt_traits_header`	No	Boolean, or comma-separated boolean list, controlling whether habitattxt trait export_name or JSON key is used as a prefix.	`1 or 1,0,1`
`include_taxon_vernaculars`	No	When 1, BRAHMS vernacular also includes names linked to the individual taxon.	`0`
`include_vernaculars`	No	When 1, includes vernacular names in BRAHMS output.	`1`
`include_voucher_individuals`	No	For BRAHMS individual-level exports with a dataset filter, include individuals outside the dataset when they have vouchers in the requested dataset.	`1`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`lang`	No	Language code/name. For BRAHMS, this must match a languages record where is_locale=1 and is used for trait category and color names; it does not affect vernacular names.	`pt-br`
`limit`	No	Maximum number of records to return.	`100`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_root`	No	Location id/name with descendants included.	`Amazonas or 10`
`locnotes_traits`	No	Measurement trait id/export_name or JSON note key list for BRAHMS locnotes. JSON keys are searched in individual and individual-location notes; measurements are searched on individual and current location. Use all or none. Default none keeps locnotes as individual-location notes only.	`none or trail_notes,soil_type`
`locnotes_traits_header`	No	Boolean, or comma-separated boolean list, controlling whether locnotes trait export_name or JSON key is used as a prefix.	`1 or 1,0,1`
`measurement_dataset`	No	Dataset id/name list used to limit measurements summarized in BRAHMS descriptions.	`Flora-INPA`
`odbrequest_id`	No	Filter individuals linked to a given request id.	`12`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`plantdesc_traits`	No	Measurement trait id/export_name or individual JSON note key list for BRAHMS plantdesc. Use all or none.	`all or leaf_color,dbh or none`
`plantdesc_traits_header`	No	Boolean, or comma-separated boolean list, controlling whether plantdesc trait export_name or JSON key is used as a prefix.	`1 or 1,0,1`
`project`	No	Project id or acronym.	`PDBFF or 2`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`tag`	No	Individual tag/number/code.	`A-1234`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`
`trait`	No	Trait id or export_name filter.	`DBH`
`vernacular`	No	Vernacular id or name list used to filter individuals.	`castanha\|12`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`odbUuid`	`simple` / `all`	BRAHMS/INPA export column: OpenDataBio UUID of the exported source record.
`collector`	`simple` / `all`	BRAHMS/INPA export column for the main collector name or abbreviation.
`number`	`simple` / `all`	Record, collection, or BRAHMS number value; the exact meaning depends on the endpoint.
`addcoll`	`simple` / `all`	BRAHMS/INPA export column for additional collectors.
`colldd`	`simple` / `all`	BRAHMS/INPA export column for collection day.
`collmm`	`simple` / `all`	BRAHMS/INPA export column for collection month.
`collyy`	`simple` / `all`	BRAHMS/INPA export column for collection year.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`genus`	`simple` / `all`	Darwin Core taxonomic column: genus associated with the exported taxon or identified organism.
`sp1`	`simple` / `all`	BRAHMS/INPA export column for the first species epithet field.
`sp2`	`simple` / `all`	BRAHMS/INPA export column for the second epithet or infraspecific name field.
`detby`	`simple` / `all`	BRAHMS/INPA export column for the person who identified the specimen or individual.
`country`	`simple` / `all`	Country name or code associated with a location.
`majorarea`	`simple` / `all`	BRAHMS/INPA export column for the major geographic area.
`minorarea`	`simple` / `all`	BRAHMS/INPA export column for the minor geographic area.
`gazetteer`	`simple` / `all`	BRAHMS/INPA export column for the gazetteer or named locality.
`locnotes`	`simple` / `all`	BRAHMS/INPA export column for locality notes, related locations, and local position information.
`habitattxt`	`simple` / `all`	BRAHMS/INPA export column for habitat text, usually derived from measurements of the current location when available.
`lat`	`simple` / `all`	BRAHMS/INPA export column: latitude value formatted for the BRAHMS exchange table.
`NS`	`simple` / `all`	BRAHMS/INPA export column indicating whether latitude is north or south.
`long`	`simple` / `all`	BRAHMS/INPA export column: longitude value formatted for the BRAHMS exchange table.
`EW`	`simple` / `all`	BRAHMS/INPA export column indicating whether longitude is east or west.
`llunit`	`simple` / `all`	BRAHMS/INPA export column describing the latitude/longitude unit or format.
`alt`	`simple` / `all`	BRAHMS/INPA export column for elevation or altitude.
`plantdesc`	`simple` / `all`	BRAHMS/INPA export column for plant description, derived from individual or voucher measurements and notes.
`vernacular`	`simple` / `all`	BRAHMS/INPA export column for vernacular names.
`project`	`simple` / `all`	BRAHMS/INPA export column for project name, acronym, or code.
`campo`	`all`	BRAHMS/INPA export column used by local workflows to identify the field or source context.
`accession`	`all`	BRAHMS/INPA export column for accession or collection accession value.
`prefix`	`all`	BRAHMS/INPA export column for collector number prefix.
`suffix`	`all`	BRAHMS/INPA export column for collector number suffix.
`initial`	`all`	BRAHMS/INPA export column for collector initials or local initials field.
`detstatus`	`all`	BRAHMS/INPA export column for determination status.
`rank1`	`all`	BRAHMS/INPA export column for infraspecific rank.
`detdd`	`all`	BRAHMS/INPA export column for identification day.
`detmm`	`all`	BRAHMS/INPA export column for identification month.
`detyy`	`all`	BRAHMS/INPA export column for identification year.
`alt1`	`all`	BRAHMS/INPA export column for secondary elevation or altitude value.
`dups`	`all`	BRAHMS/INPA export column for duplicate specimen information.

identification-histories (GET)

Identification history records (GET lists, POST creates manual history rows).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records.	`1,2,3`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`date_max`	No	Filter records occurring on/before this date (YYYY-MM-DD).	`2024-12-31`
`date_min`	No	Filter records occurring on/after this date (YYYY-MM-DD).	`2020-01-01`
`fields`	No	Comma separated list of the fields to include in the response or special words all/simple/raw, default to simple	`id,scientificName or all`
`identification_id`	No	Identification record id. For POST identification-histories this is optional; when provided, it must belong to individual_id. When omitted, the API derives it from individual_id.	`123`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`individual_id`	No	Individual id list for occurrence queries.	`12,55,90`
`job_id`	No	Job id to reuse affected ids or filter results from a job.	`1024`
`limit`	No	Maximum number of records to return.	`100`
`offset`	No	The starting position of the record set to be exported. Used together with `limit` to limit results.	`10000`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`save_job`	No	If 1, save the results as file to download later via userjobs + get_file = T	`1`
`source`	No	Source label for generated or imported records.	`api`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`taxon_root`	No	Taxon id/name including descendants.	`Lauraceae`

Fields returned

The simple profile is the default response; all adds detailed, technical, or compatibility fields. Use the fields parameter to request an explicit list.

Field	Profiles	Meaning
`id`	`simple` / `all`	Internal numeric identifier of the exported record in this OpenDataBio installation.
`identification_id`	`simple` / `all`	Internal numeric identifier of the taxonomic identification linked to the record.
`identification_uuid`	`simple` / `all`	Stable UUID of the taxonomic identification linked to the record.
`individual_id`	`simple` / `all`	Internal numeric identifier of the linked individual or organism record.
`individual_uuid`	`simple` / `all`	Stable UUID of the linked individual or organism record.
`organismID`	`simple` / `all`	Darwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Darwin Core column: human-readable label for the organism or individual record.
`taxon_id`	`simple` / `all`	Internal numeric identifier of the linked taxonomic name.
`taxon_uuid`	`simple` / `all`	Stable UUID of the linked taxonomic name.
`scientificName`	`simple` / `all`	Darwin Core taxonomic column: scientific name associated with the record at the time of export.
`family`	`simple` / `all`	Darwin Core taxonomic column: family associated with the exported taxon or identified organism.
`identificationQualifier`	`simple` / `all`	Darwin Core column: qualifier expressing uncertainty or qualification of the identification.
`identifiedBy`	`simple` / `all`	Darwin Core column: person or people responsible for the taxonomic identification.
`dateIdentified`	`simple` / `all`	Darwin Core column: date when the taxonomic identification was made.
`identificationBiocollection`	`simple` / `all`	Biocollection used as a reference for the identification, when applicable.
`identificationBiocollectionReference`	`simple` / `all`	Catalog or reference number in the biocollection used for identification.
`identificationRemarks`	`simple` / `all`	Darwin Core column: notes associated with the taxonomic identification.
`replaced_at`	`simple` / `all`	Timestamp or date when an identification history row was replaced.
`replacedByName`	`simple` / `all`	OpenDataBio local name of the identification that replaced this identification history row.
`source`	`simple` / `all`	OpenDataBio local source label for the record or identification history row.
`scientificNameAuthorship`	`all`	Darwin Core taxonomic column: authorship string associated with the scientific name.
`taxonPublishedStatus`	`all`	Publication status of the taxonomic name used in the identification.
`genus`	`all`	Darwin Core taxonomic column: genus associated with the exported taxon or identified organism.
`identifiers`	`all`	OpenDataBio local list of people responsible for a taxonomic identification.
`modifier`	`all`	OpenDataBio local identification qualifier/modifier code stored with an identification history row.
`date`	`all`	OpenDataBio local date associated with the exported record; the exact event depends on the endpoint.
`biocollection_id`	`all`	Internal numeric identifier of the linked biological collection.
`biocollection_uuid`	`all`	Stable UUID of the linked biological collection.
`replaced_by`	`all`	Internal numeric identifier of the identification history row that replaced this row.
`source_id`	`all`	OpenDataBio local identifier of the source record or source process.
`source_payload`	`all`	OpenDataBio local structured payload from the source process, usually encoded as JSON.
`created_at`	`all`	Timestamp when the record was created in OpenDataBio.
`updated_at`	`all`	Timestamp when the record was last updated in OpenDataBio.

3 - Post data

How to import data to OpenDataBio using the API

Importing data

The OpenDataBio-R package is a client for this API and lets you import, download and update data from R objects.
Examples of importing from R are here;
Data can be imported via the web interface using spreadsheets, where the column names are the POST parameters listed on this page
An authentication token is required for all POST requests
Imports may run as background UserJobs. A completed job may still contain per-record warnings or errors; inspect its structured results.

The former activities import endpoint has been removed. Use the identification-histories endpoint for biological identification history. The application activity log is an audit trail and is not an importable biological history.

Structured custom data in the `notes` field

The notes field of any model is for plain text or a text formatted as a JSON object containing structured data. Json allows you to store custom structured data in any model that has the notes field. For example, you may want to store secondary fields from source datasets during import, or any additional data not provided by the OpenDataBio database structure. This data is not validated by OpenDataBio and the standardization of tags and values is up to you. Json notes will be imported and exported as JSON text and will be presented in the interface as a formatted table; URLs in your Json will be presented as links in this table.

POST endpoints

bibreferences (POST)

Bibliographic references (GET lists, POST creates).

Parameter	Required	Description	Example
`bibtex`	No	BibTeX formatted reference string. (Provide doi or bibtex.)	`@article{mykey,...}`
`doi`	No	DOI number or URL. (Provide doi or bibtex.)	`10.1234/abcd.2020.1`

biocollections (POST)

Biocollections (GET lists, POST creates).

Parameter	Required	Description	Example
`acronym`	Yes	Biocollection acronym.	`INPA`
`name`	Yes	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`

individuals (POST)

Individuals (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`altitude`	No	Elevation in meters.	`75`
`angle`	No	Azimuth from reference point, in degrees.	`45`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`biocollection_number`	No	Catalogue number/code inside the biocollection.	`12345`
`biocollection_type`	No	Nomenclatural type code or name.	`Holotype or 2`
`collector`	Yes	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	Yes	Dataset id or acronym.	`3 or FOREST1`
`date`	Yes	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day. (At least the year must be provided.)	`2024-05-20 or {\"year\":1888,\"month\":5}`
`distance`	No	Distance from reference point in meters.	`12.5`
`identification_based_on_biocollection`	No	Biocollection name/id used as reference for identification.	`INPA`
`identification_based_on_biocollection_number`	No	CatalogNumber in the reference biocollection	`8765`
`identification_date`	No	Identification date (full or incomplete).	`2023-06-NA`
`identification_individual`	No	ID/organismID of another individual that provides the taxonomic identification for the individual’s record	`3245 or REC-123`
`identification_notes`	No	Notes for the identification.	`Checked with microscope`
`identifier`	No	Person(s) responsible for identification; accept id, abbreviation, name or email; separate multiple with \| or ;. Required when taxon is informed. Use identifier=collector to use the collector value explicitly provided in the same record, or identifier=keep in updates to preserve the existing identifier.	`Costa, A.\|Lima, B. or 1\|2\|3 or collector or keep`
`latitude`	No	Latitude in decimal degrees (negative for south). (Required when location is not provided.)	`-3.101`
`location`	No	Location id or name. (Required when latitude/longitude are not provided.)	`Parcela 25ha or 55`
`location_date_time`	No	Date or date+time for the occurrence/location event. (Required when adding multiple locations or when different from individual date.)	`2023-08-14 12:30:00`
`location_notes`	No	Notes for the occurrence/location entry.	`Near trail marker 10`
`longitude`	No	Longitude in decimal degrees (negative for west). (Required when location is not provided.)	`-60.12`
`modifier`	No	Identification modifier code/name (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`tag`	Yes	Individual tag/number/code.	`A-1234`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`
`x`	No	Cartesian coordinate for individual within plot/transect, from origin	`10`
`y`	No	Cartesian coordinate for individual within plot/transect. When transect, positive values for right-side and negative for left-side, from origin.	`5.1`

individual-locations (POST)

Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).

Parameter	Required	Description	Example
`altitude`	No	Elevation in meters.	`75`
`angle`	No	Azimuth from reference point, in degrees.	`45`
`distance`	No	Distance from reference point in meters.	`12.5`
`individual`	Yes	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`latitude`	No	Latitude in decimal degrees (negative for south). (Required when location is not provided.)	`-3.101`
`location`	No	Location id or name. (Required when latitude/longitude are not provided.)	`Parcela 25ha or 55`
`location_date_time`	Yes	Date or date+time for the occurrence/location event.	`2023-08-14 12:30:00`
`location_notes`	No	Notes for the occurrence/location entry.	`Near trail marker 10`
`longitude`	No	Longitude in decimal degrees (negative for west). (Required when location is not provided.)	`-60.12`
`x`	No	Cartesian coordinate for individual within plot/transect, from origin	`10`
`y`	No	Cartesian coordinate for individual within plot/transect. When transect, positive values for right-side and negative for left-side, from origin.	`5.1`

locations (POST)

Locations (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`adm_level`	Yes	Location administrative level code (e.g. 100=plot, 10=country).	`100`
`altitude`	No	Elevation in meters.	`75`
`azimuth`	No	Azimuth (degrees) used to build plot/transect geometry when location is a POINT.	`90`
`datum`	No	Spatial datum/projection string.	`EPSG:4326-WGS 84`
`geojson`	No	Input-only GeoJSON Feature with geometry and at least name + adm_level properties. It is parsed into the location geometry and is not stored as a locations.geojson column. (Provide geojson, geom or lat+long.)	`{\"type\":\"Feature\",\"properties\":{\"name\":\"Plot A\",\"adm_level\":100},\"geometry\":{...}}`
`geom`	No	WKT geometry (POINT, LINESTRING, POLYGON, MULTIPOLYGON). (Provide geojson, geom or lat+long.)	`POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3))`
`ismarine`	No	Flag to allow marine/offshore locations outside country polygons.	`1`
`lat`	No	Latitude in decimal degrees (negative for south). (Provide geojson, geom or lat+long.)	`-3.101`
`long`	No	Longitude in decimal degrees (negative for west). (Provide geojson, geom or lat+long.)	`-60.12`
`name`	Yes	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	No	Parent id/name; for traits this is another trait export_name/id to define hierarchy.	`woodDensity`
`startx`	No	Start X coordinate for subplot relative to parent plot.	`5.5`
`starty`	No	Start Y coordinate for subplot relative to parent plot.	`10.0`
`x`	No	X dimension for plots/transects	`100`
`y`	No	Y dimension for plots or buffer for transects	`40`

locations-validation (POST)

Validates coordinates against registered locations (POST).

Parameter	Required	Description	Example
`latitude`	Yes	Latitude in decimal degrees (negative for south).	`-3.101`
`longitude`	Yes	Longitude in decimal degrees (negative for west).	`-60.12`

measurements (POST)

Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).

Parameter	Required	Description	Example
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`dataset`	Yes	Dataset id/name where the measurement will be stored; falls back to authenticated user default dataset if omitted.	`3 or FOREST1`
`date`	Yes	Measurement date; accepts YYYY-MM-DD, YYYY-MM, YYYY, or array/year-month-day fields (date_year/date_month/date_day).	`2024-05-10 or {\"year\":2024,\"month\":5}`
`duplicated`	No	Integer allowing repeated measurements on the same date/object; must be higher than existing duplicates.	`2`
`link_id`	No	Required for LINK trait types: id of the linked object (e.g., Taxon id). (Required when trait type is Link.)	`55`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`notes`	No	Optional free text or JSON notes stored with the measurement.	`{\"method\":\"caliper\"}`
`object_id`	Yes	Required. Id of the measured object (Individual, Location, Taxon, Voucher, Media). Alias: measured_id.	`4521`
`object_type`	Yes	Required when not provided in header. Class basename or FQCN of the measured object (Individual, Location, Taxon, Voucher, Media). Alias: measured_type.	`Individual`
`parent_measurement`	No	When trait depends on another measurement, provide the parent measurement id for the same object and date.	`3001`
`person`	Yes	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`trait_id`	Yes	Required. Trait id or export_name to be measured (also accepts trait key “trait”).	`DBH or 12`
`value`	No	Input varies by trait type: QUANT_INTEGER (0) = integer number; QUANT_REAL (1) = decimal number with dot separator; CATEGORICAL or ORDINAL (2/4) = single category id or translated name; CATEGORICAL_MULTIPLE (3) = list of category ids/names separated by \| ; or , (or an array); TEXT (5) = free text string; COLOR (6) = hex color like #A1B2C3 or #ABC; LINK (7) = send link_id pointing to the linked object (value may be blank or a numeric qualifier); SPECTRAL (8) = semicolon-separated numeric series whose length equals trait value_length; GENEBANK (9) = GenBank accession string (validated against NCBI). (Required unless trait type is Link.)	`QUANT_REAL: 23.4 \| CATEGORICAL: 15 or Dead \| CATEGORICAL_MULTIPLE: 12;14 or Alternate;Opposite \| SPECTRAL: 0.12;0.11;0.10`

media (POST)

Media metadata (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`filename`	Yes	Exact media file name inside the ZIP when importing media.	`IMG_0001.jpg`
`latitude`	No	Latitude in decimal degrees (negative for south).	`-3.101`
`license`	No	Public license code for media (CC0, CC-BY, CC-BY-SA, etc.).	`CC-BY-SA`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`longitude`	No	Longitude in decimal degrees (negative for west).	`-60.12`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`object_id`	Yes	Id of object the media belongs to (Individual, Location, Taxon, Voucher).	`4521`
`object_type`	Yes	The object type the media belongs to, one of Individual, Location, Taxon, or Voucher.	`Individual`
`project`	No	Project id or acronym.	`PDBFF or 2`
`tags`	No	Tag ids or names list for media or filters (use \| or ;).	`flower\|leaf`
`title_en`	No	Media title in English.	`Leaf detail`
`title_pt`	No	Media title in Portuguese.	`Detalhe da folha`

persons (POST)

People (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`abbreviation`	No	Standard abbreviation for a person or biocollection.	`Silva, J.B, Pilco, M.V.`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`email`	No	Email address.	`user@example.org`
`full_name`	Yes	Person full name.	`Joao Silva`
`institution`	No	Institution associated with a person.	`INPA`

taxons (POST)

Taxonomic names (GET lists, POST creates).

Parameter	Required	Description	Example
`author`	No	Optional authorship string for published names. It is commonly filled automatically by API. For unpublished names, keep author null and use author_id/person.	`Nees`
`author_id`	No	Alternative to person for unpublished names. Required for unpublished names when person is not sent. (Required for unpublished names (or use person).)	`25`
`bibkey`	No	Optional bibreference id or bibkey to resolve bibreference_id. For published names, API-derived bibliographic data may also populate the record.	`ducke1953 or 34`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`enforceValid`	No	Optional boolean override for published names. Use when you send valid=true and want to override an API result that marks the name as invalid and assigns a senior name.	`1 or true`
`gbif`	No	Optional GBIF id. For POST it is stored as informed; no API validation is required for this explicit value.	`28792`
`indexfungorum`	No	Index Fungorum identifier for a taxon.	`IF123456`
`ipni`	No	Optional IPNI id. For POST it is stored as informed; no API validation is required for this explicit value.	`123456-1`
`level`	No	Optional for published names because API lookup may define it. Required for unpublished names except when the validated name is a two-word binomial, which is imported as species. Accepts numeric rank code or rank name such as species/subspecies/clade.	`210 or species`
`mobot`	No	Optional Tropicos/MOBOT id. For POST it is stored as informed; no API validation is required for this explicit value.	`25509881`
`mycobank`	No	Optional MycoBank id. For POST it is stored as informed; no API validation is required for this explicit value.	`MB123456`
`name`	Yes	Required taxon name. For published names, POST validates the name against external nomenclatural APIs and may normalize name, parent, rank, validity, senior_id, authorship, bibreference, and external ids. For unpublished names, inform author_id/person and parent; level is required unless the validated name is a two-word binomial, which is imported as species.	`Ocotea guianensis or Inga sp. 1`
`parent`	No	Optional for published names, required for unpublished names. Accepts parent id or scientific name. For published names, if the API finds a different parent, the informed parent is kept and a warning is logged. (Required for unpublished names.)	`Ocotea or 120`
`parent_id`	No	Parent id for hierarchical queries.	`210`
`parent_name`	No	Alternative parent taxon name used by taxon imports and updates.	`Ocotea`
`person`	No	Use for unpublished names only. Accepts person id, abbreviation, full name, or email; resolved to author_id. When present, the record is treated as unpublished and API lookup is not used. (Required for unpublished names (or use author_id).)	`25 or Pilco, M.V.`
`senior`	No	Accepted senior taxon id or name used when importing an invalid taxon.	`Ocotea guianensis`
`senior_id`	No	Optional accepted-name taxon id used when the imported taxon is invalid. The senior taxon must already exist, must be valid, and must be published.	`345`
`valid`	No	Optional boolean. When omitted on POST, validity is inferred from senior/senior_id or API result. Invalid names are allowed for both published and unpublished taxa. If you send valid=true for a published name and the API says the name is invalid, the import is rejected unless enforceValid=true is also sent.	`1 or 0`
`zoobank`	No	Optional ZooBank id. For POST it is stored as informed; no API validation is required for this explicit value.	`urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`

traits (POST)

Trait definitions (GET lists, POST creates).

Parameter	Required	Description	Example
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`categories`	No	Trait categories JSON list with lang/rank/name/description. (Required for categorical and ordinal traits.)	`[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]`
`description`	Yes	Translatable description text. Accepts a plain string or a JSON map of language codes to descriptions.	`{"en":"Tree height at breast height","pt-br":"Altura da árvore à altura do peito"}`
`export_name`	Yes	Unique export name for trait.	`treeDbh,plantHeight`
`link_type`	No	Class name for Link trait target (e.g. Taxon). (Required for Link traits.)	`Taxon`
`name`	Yes	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`objects`	Yes	Trait target objects (comma separated).	`Individual,Voucher`
`parent`	No	Parent trait id or export_name; when set, measurements of this trait must also include a measurement for the parent trait.	`woodDensity`
`range_max`	No	Maximum allowed numeric value for quantitative traits.	`999.9`
`range_min`	No	Minimum allowed numeric value for quantitative traits.	`0.01`
`tags`	No	Tag ids or names list for media or filters (use \| or ;).	`flower\|leaf`
`type`	Yes	Generic type parameter (trait type code or vernacular type such as use/generic/etimology).	`use or 10`
`unit`	No	(Required for quantitative and spectral traits.)	—
`value_length`	No	Number of values for spectral trait types. (Required for spectral traits.)	`1024`
`wavenumber_max`	No	Maximum wavenumber for spectral traits. (Required for spectral traits.)	`25000`
`wavenumber_min`	No	Minimum wavenumber for spectral traits. (Required for spectral traits.)	`4000`

vernaculars (POST)

Vernacular names (GET lists, POST creates).

Parameter	Required	Description	Example
`citations`	No	List of citations (text + bibreference) for vernaculars.	`[{\"citation\":\"Silva 2020\",\"bibreference\":12}]`
`individuals`	No	List of individual ids/fullnames for vernacular links.	`12\|23\|45`
`language`	Yes	Language id/code/name. For POST vernaculars, registered languages are accepted; absent languages are created from config/languagesISO6393.php only when the informed value matches an ISO639-3 code or configured language name, with is_locale=0.	`en or 1 or english or spa`
`name`	Yes	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	No	Parent id/name; for traits this is another trait export_name/id to define hierarchy.	`woodDensity`
`taxons`	No	List of taxon ids/names (vernacular links).	`Euterpe edulis\|Euterpe precatoria`
`type`	No	Generic type parameter (trait type code or vernacular type such as use/generic/etimology).	`use or 10`

vouchers (POST)

Voucher specimens (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`biocollection`	Yes	Biocollection id, name or acronym.	`INPA`
`biocollection_number`	No	Catalogue number/code inside the biocollection.	`12345`
`biocollection_type`	No	Nomenclatural type code or name.	`Holotype or 2`
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`individual`	Yes	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`number`	No	Collector number/code (voucher/individual tag when different from individual).	`1234A`

datasets (POST)

Datasets and published dataset versions (GET lists, POST creates via import job).

Parameter	Required	Description	Example
`description`	No	Translatable description text. Accepts a plain string or a JSON map of language codes to descriptions. (Required when privacy is 2 or 3.)	`{"en":"Tree height at breast height","pt-br":"Altura da árvore à altura do peito"}`
`license`	No	Public license code for media (CC0, CC-BY, CC-BY-SA, etc.). (Required when privacy is 2 or 3.)	`CC-BY-SA`
`name`	Yes	Short name or nickname for the dataset - make informative, shorter than title.	`Morphometrics-Aniba`
`privacy`	Yes	(Accepted values: 0 (auth), 1 (project), 2 (registered), 3 (public).)	—
`project_id`	No	(Required when privacy is 1 (project).)	—
`share_taxon_list`	No	Dataset option controlling whether the dataset taxon list can be shared in public phylogeny/taxon-list contexts. (Optional boolean; defaults to true.)	`1 or true`
`title`	No	(Required when privacy is 2 or 3.)	—
`visibility`	No	(Optional for privacy 0 or 1; mandatory true when privacy is 2 or 3.)	—

identification-histories (POST)

Identification history records (GET lists, POST creates manual history rows).

Parameter	Required	Description	Example
`biocollection_id`	No	Biocollection id list for voucher filtering.	`1,5`
`biocollection_reference`	No	(Requires biocollection_id when provided.)	—
`date`	Yes	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`identification_id`	No	Identification record id. For POST identification-histories this is optional; when provided, it must belong to individual_id. When omitted, the API derives it from individual_id. (Optional. When provided, it must belong to individual_id; otherwise it is derived from individual_id.)	`123`
`identifier`	No	Person(s) responsible for identification; accept id, abbreviation, name or email; separate multiple with \| or ;. Required when taxon is informed. Use identifier=collector to use the collector value explicitly provided in the same record, or identifier=keep in updates to preserve the existing identifier. (Provide identifier, identifier_id, or identifiers.)	`Costa, A.\|Lima, B. or 1\|2\|3 or collector or keep`
`identifier_id`	No	Person id or delimited person id list responsible for an identification. (Provide identifier, identifier_id, or identifiers.)	`4 or 4\|7`
`identifiers`	No	Person reference or delimited person list responsible for an identification. Each item may be a person id, abbreviation, full name, or email. (Provide identifier, identifier_id, or identifiers.)	`4\|7 or Costa, A.\|Lima, B.`
`individual_id`	Yes	Individual id list for occurrence queries.	`12,55,90`
`modifier`	No	Identification modifier code/name (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`replaced_at`	No	Timestamp when the identification was replaced.	`2026-06-11 10:30:00`
`source`	No	Source label for generated or imported records.	`api`
`taxon_id`	Yes		—

4 - Put data

Which EndPoints allow PUT in the API!

Attention

individuals (PUT)

Individuals (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or individual_id.)	`12`
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`identification_based_on_biocollection`	No	Biocollection name/id used as reference for identification.	`INPA`
`identification_based_on_biocollection_number`	No	CatalogNumber in the reference biocollection	`8765`
`identification_date`	No	Identification date (full or incomplete).	`2023-06-NA`
`identification_individual`	No	ID/organismID of another individual that provides the taxonomic identification for the individual’s record	`3245 or REC-123`
`identification_notes`	No	Notes for the identification.	`Checked with microscope`
`identifier`	No	Person(s) responsible for identification; accept id, abbreviation, name or email; separate multiple with \| or ;. Required when taxon is informed. Use identifier=collector to use the collector value explicitly provided in the same record, or identifier=keep in updates to preserve the existing identifier.	`Costa, A.\|Lima, B. or 1\|2\|3 or collector or keep`
`individual_id`	No	Numeric ID of the record to be updated (Provide id or individual_id.)	`12`
`modifier`	No	Identification modifier code/name (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`tag`	No	Individual tag/number/code.	`A-1234`
`taxon`	No	Taxon id or canonical full name list.	`Licaria cannela or 456,789`

individual-locations (PUT)

Occurrences for individuals with multiple locations (GET lists, POST/PUT upserts).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or individual_location_id.)	`12`
`altitude`	No	Elevation in meters.	`75`
`angle`	No	Azimuth from reference point, in degrees.	`45`
`distance`	No	Distance from reference point in meters.	`12.5`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`individual_location_id`	No	Individual-location record id. (Provide id or individual_location_id.)	`44`
`latitude`	No	Latitude in decimal degrees (negative for south).	`-3.101`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`location_date_time`	No	Date or date+time for the occurrence/location event.	`2023-08-14 12:30:00`
`location_notes`	No	Notes for the occurrence/location entry.	`Near trail marker 10`
`longitude`	No	Longitude in decimal degrees (negative for west).	`-60.12`
`x`	No	Cartesian coordinate for individual within plot/transect, from origin	`10`
`y`	No	Cartesian coordinate for individual within plot/transect. When transect, positive values for right-side and negative for left-side, from origin.	`5.1`

locations (PUT)

Locations (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or location_id.)	`12`
`adm_level`	No	Location administrative level code (e.g. 100=plot, 10=country).	`100`
`altitude`	No	Elevation in meters.	`75`
`datum`	No	Spatial datum/projection string.	`EPSG:4326-WGS 84`
`geom`	No	WKT geometry (POINT, LINESTRING, POLYGON, MULTIPOLYGON).	`POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3))`
`ismarine`	No	Flag to allow marine/offshore locations outside country polygons.	`1`
`lat`	No	Latitude in decimal degrees (negative for south).	`-3.101`
`location_id`	No	Location id of the record to update. (Provide id or location_id.)	`44`
`long`	No	Longitude in decimal degrees (negative for west).	`-60.12`
`name`	No	Translatable trait name. Accepts a plain string or a JSON map of language codes to names.	`{"en":"Height","pt-br":"Altura"}`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	No	Parent id/name; for traits this is another trait export_name/id to define hierarchy.	`woodDensity`
`startx`	No	Start X coordinate for subplot relative to parent plot.	`5.5`
`starty`	No	Start Y coordinate for subplot relative to parent plot.	`10.0`
`x`	No	X dimension for plots/transects	`100`
`y`	No	Y dimension for plots or buffer for transects	`40`

measurements (PUT)

Trait measurements (GET lists, POST creates/imports via ImportMeasurements job, PUT bulk updates).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or measurement_id.)	`12`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`duplicated`	No	Sequential number to allow duplicate measurements for same trait+object+date.	`2 for a second measurement, number 3 for third, ...`
`link_id`	No	Linked object id when trait type is Link.	`taxon id 55`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`measurement_id`	No	Measurement id of the record to update. (Provide id or measurement_id.)	`77`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`object_id`	No	Id of the measured object (Individual, Location, Taxon, Voucher or Media).	`4521`
`object_type`	No	Measured object type: Individual, Location, Taxon, Voucher, or Media.	`Individual`
`parent_measurement`	No	Parent measurement ID for measurements whose variable depends on the measurement of another variable	`3001`
`person`	No	Person id, abbreviation, full name or email (supports lists with \| or ;).	`J.Silva\|M.Costa`
`trait_id`	No	Trait id or export_name for measurements.	`12 or DBH`
`value`	No	Measurement payload varies by trait type: QUANT_INTEGER (0) = integer number; QUANT_REAL (1) = decimal number with dot separator; CATEGORICAL or ORDINAL (2/4) = single category id or translated name; CATEGORICAL_MULTIPLE (3) = list of category ids/names separated by \| ; or , (or an array); TEXT (5) = free text string; COLOR (6) = hex color like #A1B2C3 or #ABC; LINK (7) = send link_id pointing to the linked object (value may be blank or a numeric qualifier); SPECTRAL (8) = semicolon-separated numeric series whose length equals trait value_length; GENEBANK (9) = GenBank accession string (validated against NCBI).	`QUANT_REAL: 23.4 \| CATEGORICAL: 15 \| CATEGORICAL_MULTIPLE: 12\|14 \| SPECTRAL: 0.12;0.11;0.10`

media (PUT)

Media metadata (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Single id or comma-separated list to filter or target records. (Provide id, media_id or media_uuid.)	`1,2,3`
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`latitude`	No	Latitude in decimal degrees (negative for south).	`-3.101`
`license`	No	Public license code for media (CC0, CC-BY, CC-BY-SA, etc.).	`CC-BY-SA`
`location`	No	Location id or name.	`Parcela 25ha or 55`
`longitude`	No	Longitude in decimal degrees (negative for west).	`-60.12`
`media_id`	No	Media numeric id. (Provide id, media_id or media_uuid.)	`88`
`media_uuid`	No	Media UUID. (Provide id, media_id or media_uuid.)	`a3f0a4ac-6b5b-11ed-b8c0-0242ac120002`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`project`	No	Project id or acronym.	`PDBFF or 2`
`tags`	No	Tag ids or names list for media or filters (use \| or ;).	`flower\|leaf`
`title_en`	No	Media title in English.	`Leaf detail`
`title_pt`	No	Media title in Portuguese.	`Detalhe da folha`

persons (PUT)

People (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or person_id.)	`12`
`abbreviation`	No	Standard abbreviation for a person or biocollection.	`Silva, J.B, Pilco, M.V.`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`email`	No	Email address.	`user@example.org`
`full_name`	No	Person full name.	`Joao Silva`
`institution`	No	Institution associated with a person.	`INPA`
`person_id`	No	Person id of the record to update. (Provide id or person_id.)	`12`

vouchers (PUT)

Voucher specimens (GET lists, POST creates, PUT updates).

Parameter	Required	Description	Example
`id`	No	Numeric ID of the record to be updated (Provide id or voucher_id.)	`12`
`biocollection`	No	Biocollection id, name or acronym.	`INPA`
`biocollection_number`	No	Catalogue number/code inside the biocollection.	`12345`
`biocollection_type`	No	Nomenclatural type code or name.	`Holotype or 2`
`clear_biocollection_number`	No	When 1, clears the current biocollection_number on update.	`1`
`collector`	No	Collector(s) id, abbreviation, name or email. Use \| or ; to separate multiple people; first is main collector.	`J.Silva\|M.Costa`
`dataset`	No	Dataset id or acronym.	`3 or FOREST1`
`date`	No	Date (YYYY-MM-DD) or incomplete date (e.g. 1888-05-NA) or array with year/month/day.	`2024-05-20 or {\"year\":1888,\"month\":5}`
`individual`	No	Individual id, uuid or organismID (fullname).	`4521 or 2ff0e884-3d33`
`notes`	No	Free text or JSON notes field.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`number`	No	Collector number/code (voucher/individual tag when different from individual).	`1234A`
`voucher_id`	No	Voucher id of the record to update. (Provide id or voucher_id.)	`55`

taxons (PUT)

Taxonomic names (GET lists, POST creates).

Parameter	Required	Description	Example
`id`	No	Required existing taxon id to update. taxon_id is accepted as an alias. (Provide id or taxon_id.)	`12`
`author`	No	Taxon authorship string for published names. Unpublished names should leave this null and use author_id/person instead.	`Smith & Jones`
`author_id`	No	Optional unpublished-author id. If present, the taxon is treated as unpublished for duplicate checking.	`25`
`bibkey`	No	Optional bibreference id or bibkey to resolve bibreference_id.	`ducke1953 or 34`
`bibreference`	No	Bibreference id or bibkey.	`34 or ducke1953`
`bibreference_id`	No	BibReference id list for voucher filtering.	`10,11`
`enforceValid`	No	Optional boolean override for published-name updates. Use when you intentionally want to keep valid=true even though the API reports the name as invalid and returns a senior name.	`1 or true`
`gbif`	No	Optional explicit GBIF id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation.	`28792`
`indexfungorum`	No	Index Fungorum identifier for a taxon.	`IF123456`
`ipni`	No	Optional explicit IPNI id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation.	`123456-1`
`level`	No	Optional new rank code or rank name. Required when changing unpublished taxa in a way that needs rank validation and always checked against the parent.	`210 or species`
`mobot`	No	Optional explicit Tropicos/MOBOT id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation.	`25509881`
`mycobank`	No	Optional explicit MycoBank id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation.	`MB123456`
`name`	No	Optional new taxon name. If the taxon is published and name changes, external APIs are used again and may overwrite informed parent, rank, validity, senior_id, authorship, bibreference, and external ids. If the taxon is unpublished and name changes, duplicate checks are applied instead of API lookup.	`Ocotea guianensis`
`notes`	No	Optional replacement for notes. Accepts a plain string or a JSON string.	`{"reviewed_by":"J. Silva"}`
`parent`	No	Optional new parent id or scientific name. All name updates and parent changes are revalidated against taxon-level rules.	`Ocotea or 120`
`parent_id`	No	Parent id for hierarchical queries.	`210`
`parent_name`	No	Alternative parent taxon name used by taxon imports and updates.	`Ocotea`
`person`	No	Optional author reference for unpublished taxa. Accepts person id, abbreviation, full name, or email and resolves to author_id.	`25 or Pilco, M.V.`
`senior_id`	No	Optional accepted-name taxon id. Allowed only when valid=false. The referenced senior taxon must be valid and published; unpublished senior names are rejected.	`345`
`taxon_id`	No	Alias of id for update payloads. (Provide id or taxon_id.)	`12`
`valid`	No	Optional boolean. Both published and unpublished taxa may be invalid. If set to true, senior_id is cleared. If set to false on a published name, senior_id must be informed. If you send valid=true for a published-name rename and the API says the name is invalid, the update is rejected unless enforceValid=true is also sent.	`1 or 0`
`zoobank`	No	Optional explicit ZooBank id. If a published-name rename triggers API lookup, API-derived value has priority; otherwise the informed value is stored without extra validation.	`urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`

API services

The API call

API Authentication

API versions

1 - Quick reference

GET DATA (downloads)

Shared get-parameters

Endpoint parameters

POST DATA (imports)

PUT DATA (updates)

Nomenclature types

Taxonomic ranks

2 - GET data

Shared GET parameters

Selecting response fields

GET endpoints

Quick links

/ (GET)

bibreferences (GET)

Fields returned

Response example

biocollections (GET)

Fields returned

Response example

datasets (GET)

Fields returned

Response example

individuals (GET)

Fields returned

Response example

individual-locations (GET)

Fields returned

Response example

languages (GET)

Response example

locations (GET)

Fields returned

Response example

measurements (GET)

Fields returned

Response example

media (GET)

Fields returned

Response example

persons (GET)

Fields returned

Response example

projects (GET)

Fields returned

Response example

taxons (GET)

Fields returned

Response example

traits (GET)

Fields returned

Response example

vernaculars (GET)

Fields returned

Response example

vouchers (GET)

Fields returned

Response example

userjobs (GET)

Fields returned

Response example

activities (GET)

Fields returned

Response example

tags (GET)

Fields returned

Response example

brahms (GET)

Fields returned

identification-histories (GET)

Fields returned

3 - Post data

Importing data

Structured custom data in the notes field

POST endpoints

Quick links

Structured custom data in the `notes` field