GET data

How to get data using the API!

Shared GET parameters

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
limitNoMaximum number of records to return.100
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1

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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibkeyNoBibreference key or list of keys.ducke1953,mayr1992
biocollectionNoBiocollection id/name/acronym; returns references cited by vouchers in those collections.INPA
datasetNoDataset id or name; returns bibreferences linked to the dataset.Forest1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-text search on bibtex using boolean mode; spaces act as AND.Amazon forest
taxonNoTaxon id or canonical name list; matches references linked to the taxon.Ocotea guianensis or 120,455
taxon_rootNoTaxon 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
bibkeysimple / allOpenDataBio local short key used to identify a bibliographic reference.
yearsimple / allPublication year of a bibliographic reference.
authorsimple / allAuthor string for a bibliographic reference or taxonomic name, depending on the endpoint.
titlesimple / allTitle of a bibliographic reference or dataset, depending on the endpoint.
doisimple / allDigital Object Identifier associated with a bibliographic reference.
urlsimple / allURL associated with a bibliographic reference.
bibtexsimple / allBibTeX 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
acronymNoBiocollection acronym.INPA
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
irnNoIndex Herbariorum IRN for filtering biocollections.123456
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
nameNoExact biocollection name (string).Instituto Nacional de Pesquisas da Amazônia
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
acronymsimple / allOpenDataBio local acronym for a project or biocollection.
namesimple / allOpenDataBio local name of the exported resource.
irnsimple / allOpenDataBio local institutional registration number for a biological collection.
countryallCountry name or code associated with a location.
cityallOpenDataBio local city recorded for a biological collection.
addressallOpenDataBio 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibreferenceNoBibreference id or bibkey.34 or ducke1953
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
has_versionsNoWhen 1, returns only datasets that have public versions.1
include_urlNoWhen 1 with list_versions, include archive URL.1
limitNoMaximum number of records to return.100
list_versionsNoIf true, lists dataset version files for given id(s).1
nameNoTranslatable trait name. Accepts a plain string or a JSON map of language codes to names.{"en":"Height","pt-br":"Altura"}
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-text search parameter.Silva
summarizeNoDataset id to return content/taxonomic/trait summaries.3
tagNoIndividual tag/number/code.A-1234
tagged_withNoTag ids (comma) or text to filter datasets by tags (supports id list or full-text).12,13 or canopy leaf
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitsNoTrait ids list (comma-separated) for filtering datasets.12,15
version_idNoDataset version id to list or download.34
version_uuidNoDataset 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
namesimple / allOpenDataBio local name of the exported resource.
titlesimple / allTitle of a bibliographic reference or dataset, depending on the endpoint.
projectNamesimple / allName or acronym of the project linked to the record or dataset.
project_idsimple / allInternal numeric identifier of the project linked to the record or dataset.
project_uuidsimple / allStable UUID of the project linked to the record or dataset.
descriptionsimple / allOpenDataBio local descriptive text for the exported resource.
notessimple / allOpenDataBio local notes associated with the exported resource.
contactEmailsimple / allOpenDataBio local contact email configured for the dataset.
taggedWidthsimple / allOpenDataBio local list of tags associated with a dataset. This legacy field name is kept for API compatibility.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
privacyLevelallOpenDataBio local system access level configured for the dataset; this is not a license.
policyallOpenDataBio local full data policy text stored for a dataset.
measurements_countallOpenDataBio local count of measurements linked to the dataset.
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
datasetNoDataset id/name, filter records that belong to the dataset informed3 or FOREST1
date_maxNoInclusive end date (YYYY-MM-DD) compared against individual date.2024-12-31
date_minNoInclusive start date (YYYY-MM-DD) compared against individual date.2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
locationNoLocation id/name list; matches individuals at those exact locations.Parcela 25ha or 55,60
location_rootNoLocation id/name; includes descendants of the informed locations.Parcela 25ha get subplots in this case
odbrequest_idNoRequest id to filter individuals linked to that ODB request.12
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoCollector person id/name/email list; filters main/associated collectors.Silva, J.B. or 23,10
projectNoProject id/name; matches records whose dataset belongs to the project.PDBFF
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
tagNoIndividual tag/number filter; supports list separated by comma.A-123,2001
taxonNoTaxon id/name list; matches identification taxon only (no descendants).Licaria guianensis,Minquartia guianensis or 456,457
taxon_rootNoTaxon id/name list; includes descendants of each taxon.Lauraceae,Fabaceae or 10,20
traitNoTrait id list; only used together with dataset to filter by measurements.12,15
vernacularNoVernacular 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
dataset_idsimple / allInternal numeric identifier of the dataset that governs the exported record.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
organismIDsimple / allDarwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as odb:{installation}:individual:{uuid}.
organismNamesimple / allDarwin Core column: human-readable label for the organism or individual record.
recordedByMainsimple / allMain collector or observer responsible for the record.
recordNumbersimple / allDarwin Core column: collector or observer record number.
eventDatesimple / allDarwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
identificationQualifiersimple / allDarwin Core column: qualifier expressing uncertainty or qualification of the identification.
identifiedBysimple / allDarwin Core column: person or people responsible for the taxonomic identification.
dateIdentifiedsimple / allDarwin Core column: date when the taxonomic identification was made.
locationNamesimple / allDarwin Core-compatible location label used by OpenDataBio for the location associated with the record.
locationParentNamesimple / allName of the parent location that contains the record location.
higherGeographysimple / allDarwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
decimalLatitudesimple / allDarwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
decimalLongitudesimple / allDarwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
xsimple / allOpenDataBio local field for occurrence position: Cartesian X coordinate of the individual within its plot, transect, or parent location.
ysimple / allOpenDataBio 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.
gxsimple / allOpenDataBio local projected or grid X coordinate for an individual position when available.
gysimple / allOpenDataBio local projected or grid Y coordinate for an individual position when available.
anglesimple / allOpenDataBio local azimuth in degrees from a reference point to an occurrence position.
distancesimple / allOpenDataBio local distance in meters from a reference point to an occurrence position.
datasetIDsimple / allDarwin 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.
datasetNamesimple / allDarwin Core column: name or title of the dataset governing the exported record.
accessRightssimple / allDarwin 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.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
recordedDateallOpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in all exports for backward compatibility; prefer eventDate for interoperability.
recordedByallDarwin Core column: collectors or observers associated with the record.
scientificNameAuthorshipallDarwin Core taxonomic column: authorship string associated with the scientific name.
taxon_idallInternal numeric identifier of the linked taxonomic name.
taxon_uuidallStable UUID of the linked taxonomic name.
identification_idallInternal numeric identifier of the taxonomic identification linked to the record.
identification_uuidallStable UUID of the taxonomic identification linked to the record.
taxonPublishedStatusallPublication status of the taxonomic name used in the identification.
genusallDarwin Core taxonomic column: genus associated with the exported taxon or identified organism.
identificationRemarksallDarwin Core column: notes associated with the taxonomic identification.
identificationBiocollectionallBiocollection used as a reference for the identification, when applicable.
identificationBiocollectionReferenceallCatalog or reference number in the biocollection used for identification.
location_idallInternal numeric identifier of the linked location.
location_uuidallStable UUID of the linked location.
georeferenceRemarksallDarwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
relatedLocationsallOther 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
organismRemarksallDarwin Core column: remarks about the organism or individual.
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
datasetNoDataset id/name; filters by dataset of the linked individual.FOREST1
date_maxNoUpper bound date/time; compares date_time or individual date when empty.2024-12-31
date_minNoLower bound date/time; compares date_time or individual date when empty.2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id list whose occurrences will be returned.12,44
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoCollector person id/name/email list; filters by individual collectors.J.Silva|23
projectNoProject id/name; matches occurrences whose individual belongs to datasets in project.PDBFF
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
tagNoIndividual tag/number list; matches by individuals.tag columnA-123,B-2
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
individual_idsimple / allInternal numeric identifier of the linked individual or organism record.
individual_uuidsimple / allStable UUID of the linked individual or organism record.
location_idsimple / allInternal numeric identifier of the linked location.
location_uuidsimple / allStable UUID of the linked location.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
occurrenceIDsimple / allDarwin 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.
organismIDsimple / allDarwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as odb:{installation}:individual:{uuid}.
organismNamesimple / allDarwin Core column: human-readable label for the organism or individual record.
eventDatesimple / allDarwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
locationNamesimple / allDarwin Core-compatible location label used by OpenDataBio for the location associated with the record.
higherGeographysimple / allDarwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
decimalLatitudesimple / allDarwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
decimalLongitudesimple / allDarwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
xsimple / allOpenDataBio local field for occurrence position: Cartesian X coordinate of this individual occurrence within its plot, transect, or parent location.
ysimple / allOpenDataBio 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.
anglesimple / allOpenDataBio local azimuth in degrees from a reference point to an occurrence position.
distancesimple / allOpenDataBio local distance in meters from a reference point to an occurrence position.
minimumElevationsimple / allDarwin Core column: lower bound of elevation for the occurrence or location, in meters.
occurrenceRemarkssimple / allDarwin Core column: remarks about the occurrence.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
datasetIDsimple / allDarwin 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.
datasetNamesimple / allDarwin Core column: name or title of the dataset governing the exported record.
accessRightssimple / allDarwin 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.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
occurrenceNameallHuman-readable label for an occurrence record.
recordedDateallOpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in all exports for backward compatibility; prefer eventDate for interoperability.
georeferenceRemarksallDarwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
organismRemarksallDarwin Core column: remarks about the organism or individual.
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort 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.

ParameterRequiredDescriptionExample
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
limitNoMaximum number of records to return.100
offsetNoThe 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
adm_levelNoOne or more adm_level codes10,100
datasetNoDataset id/name; expands to all locations used by that dataset.FOREST1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
latNoLatitude (decimal degrees) used with querytype.-3.11
limitNoMaximum number of records to return.100
location_rootNoAlias of root for compatibility.Amazonas
longNoLongitude (decimal degrees) used with querytype.-60.02
nameNoExact name match; accepts list of names or ids.Manaus or 10
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
parent_idNoParent id for hierarchical queries.210
projectNoProject id or acronym.PDBFF or 2
querytypeNoWhen lat/long are provided: exact|parent|closest geometric search.parent
rootNoLocation id/name; returns it and all descendants and related locationsAmazonas or "Parque Nacional do Jaú" ...
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoPrefix search on name (SQL LIKE name%).Mana search for names that starts "mana"
taxonNoTaxon id/name list; filters locations by linked identifications.Euterpe precatoria
taxon_rootNoTaxon id/name list; includes descendants when filtering linked identifications.Euterpe - finds alls records that belongs to this genus
traitNoTrait 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
locationIDsimple / allDarwin Core column: stable identifier of the location record, formatted by OpenDataBio as odb:{installation}:location:{uuid}.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
locationNamesimple / allDarwin Core-compatible location label used by OpenDataBio for the location associated with the record.
adm_levelsimple / allOpenDataBio local administrative level code for a location.
country_adm_levelsimple / allOpenDataBio local administrative level code identifying which location level represents the country.
xsimple / allOpenDataBio local field for location geometry: X dimension or length of a plot/transect in the location local coordinate system.
ysimple / allOpenDataBio local field for location geometry: Y dimension of a plot or buffer/width value for a transect in the location local coordinate system.
startxsimple / allOpenDataBio local starting X coordinate for a plot, transect, or local coordinate system.
startysimple / allOpenDataBio local starting Y coordinate for a plot, transect, or local coordinate system.
distance_to_searchsimple / allOpenDataBio local distance, usually in meters, between a location and the search coordinate.
parent_idsimple / allInternal numeric identifier of the parent record in a hierarchy.
parent_uuidsimple / allStable UUID of the parent record in a hierarchy.
parentNamesimple / allOpenDataBio local name of the parent location.
higherGeographysimple / allDarwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
footprintWKTsimple / allDarwin Core column: location geometry in WKT format.
locationRemarkssimple / allDarwin Core column: remarks or notes about the location.
decimalLatitudesimple / allDarwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
decimalLongitudesimple / allDarwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
georeferenceRemarkssimple / allDarwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
geodeticDatumsimple / allDarwin 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibreferenceNoBibreference id or bibkey.34 or ducke1953
datasetNoDataset id or acronym.3 or FOREST1
date_maxNoFilter records occurring on/before this date (YYYY-MM-DD).2024-12-31
date_minNoFilter records occurring on/after this date (YYYY-MM-DD).2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
measured_idNoMeasurement filter: id of the measured object (matches measured_type).4521
measured_typeNoMeasurement filter: class name of measured object (Individual, Location, Taxon, Voucher, Media).Media
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitNoTrait id or export_name filter.DBH
trait_typeNoFilter measurements by trait type code.1
voucherNoVoucher 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
measurementIDsimple / allDarwin Core column: stable identifier of the measurement record, formatted by OpenDataBio as odb:{installation}:measurement:{uuid}.
dataset_idsimple / allInternal numeric identifier of the dataset that governs the exported record.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
measured_typesimple / allOpenDataBio local model type of the object measured by a measurement record.
measured_idsimple / allInternal numeric identifier of the object measured by a measurement record.
measured_uuidsimple / allStable UUID of the object measured by a measurement record, when the object has a UUID.
trait_idsimple / allInternal numeric identifier of the linked trait.
trait_uuidsimple / allStable UUID of the linked trait.
measurementTypesimple / allDarwin Core MeasurementOrFact column: trait export name or measurement type represented by the measurement.
measurementValuesimple / allDarwin Core MeasurementOrFact column: recorded value of the measurement.
measurementUnitsimple / allDarwin Core MeasurementOrFact column: unit associated with the measurement value.
measurementDeterminedBysimple / allDarwin Core MeasurementOrFact column: person or people who determined or recorded the measurement.
measurementDeterminedDatesimple / allDarwin Core MeasurementOrFact column: date when the measurement was determined or recorded.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
datasetIDsimple / allDarwin 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.
datasetNamesimple / allDarwin Core column: name or title of the dataset governing the exported record.
sourceCitationsimple / allCitation for the source from which the record or measurement was derived.
accessRightssimple / allDarwin 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.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
dataset_uuidallStable UUID of the dataset that governs the exported record.
measurementRemarksallDarwin Core MeasurementOrFact column: notes associated with the measurement.
resourceRelationshipallDarwin Core ResourceRelationship column: type of relationship between the exported record and the resource it is linked to.
resourceRelationshipIDallDarwin Core relationship column: stable identifier of the related OpenDataBio resource, formatted as odb:{installation}:{type}:{uuid} when the related object has a stable identifier.
resourceRelationshipNameallDarwin Core ResourceRelationship-compatible column: human-readable name of the related resource.
relationshipOfResourceallDarwin Core relationshipOfResource value describing how the resource is related.
measurementMethodallDarwin Core MeasurementOrFact column: method or protocol used to obtain the measurement, i.e. trait definition and metadata
bibreference_idallInternal numeric identifier of the linked bibliographic reference.
bibreference_uuidallStable UUID of the linked bibliographic reference.
measurementLocationIdallInternal numeric identifier of the location associated with the measurement.
measurementLocationUuidallStable UUID of the location associated with the measurement.
measurementParentIdallInternal numeric identifier of the parent measurement when this measurement is nested.
measurementParentUuidallStable UUID of the parent measurement when this measurement is nested.
decimalLatitudeallDarwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
decimalLongitudeallDarwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
datasetNoDataset id or acronym.3 or FOREST1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
media_idNoMedia numeric id.88
media_uuidNoMedia UUID.a3f0a4ac-6b5b-11ed-b8c0-0242ac120002
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
tagNoIndividual tag/number/code.A-1234
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
uuidNo
voucherNoVoucher 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
model_typesimple / allOpenDataBio local model class of the object linked to a media record.
model_idsimple / allInternal numeric identifier of the OpenDataBio object linked to a media record.
model_uuidsimple / allStable UUID of the OpenDataBio object linked to a media record.
dataset_idsimple / allInternal numeric identifier of the dataset that governs the exported record.
dataset_uuidsimple / allStable UUID of the dataset that governs the exported record.
project_idsimple / allInternal numeric identifier of the project linked to the record or dataset.
project_uuidsimple / allStable UUID of the project linked to the record or dataset.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
recordedBysimple / allDarwin Core column: collectors or observers associated with the record.
eventDatesimple / allDarwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
dwcTypesimple / allDarwin Core / Dublin Core type value of the media or linked resource.
resourceRelationshipsimple / allDarwin Core ResourceRelationship column: type of relationship between the exported record and the resource it is linked to.
resourceRelationshipIDsimple / allDarwin Core relationship column: stable identifier of the related OpenDataBio resource, formatted as odb:{installation}:{type}:{uuid} when the related object has a stable identifier.
resourceRelationshipNamesimple / allDarwin Core ResourceRelationship-compatible column: human-readable name of the related resource.
relationshipOfResourcesimple / allDarwin Core relationshipOfResource value describing how the resource is related.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
datasetIDsimple / allDarwin 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.
datasetNamesimple / allDarwin Core column: name or title of the dataset governing the exported record.
projectNamesimple / allName or acronym of the project linked to the record or dataset.
taggedWithsimple / allTags or keywords associated with the record.
accessRightssimple / allDarwin 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.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
licensesimple / allLicense assigned to the media file or dataset resource.
file_namesimple / allStored file name for a media object or downloadable dataset file.
file_urlsimple / allPublic URL for retrieving the media file or downloadable file.
citationsimple / allHuman-readable citation associated with the record or media file.
recordedDateallOpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in all exports for backward compatibility; prefer eventDate for interoperability.
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort plain-language summary of the data-use permissions and obligations.
bibliographicCitationallDarwin Core / Dublin Core column: formatted bibliographic citation associated with the record.
bibtexallBibTeX representation of the bibliographic reference or media citation.
userNameallName of the OpenDataBio user associated with the record action.
created_atallTimestamp 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
abbrevNoAbbreviation search for persons.Silva, J.B, Pilco, M.V.
emailNoEmail address.user@example.org
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
nameNoTranslatable trait name. Accepts a plain string or a JSON map of language codes to names.{"en":"Height","pt-br":"Altura"}
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
full_namesimple / allOpenDataBio local full name of a person.
abbreviationsimple / allOpenDataBio local abbreviation for a person or biocollection.
emailAddresssimple / allOpenDataBio local person email address when it is available for export.
institutionsimple / allOpenDataBio local institution associated with a person.
orcidsimple / allORCID identifier associated with a person.
notessimple / allOpenDataBio 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-text search parameter.Silva
tagNoIndividual 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
acronymsimple / allOpenDataBio local acronym for a project or biocollection.
namesimple / allOpenDataBio local name of the exported resource.
descriptionsimple / allOpenDataBio local descriptive text for the exported resource.
pagesallOpenDataBio local project pages metadata.
urlsallOpenDataBio local list of URLs associated with a project.
created_atallTimestamp when the record was created in OpenDataBio.
updated_atallTimestamp 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibreferenceNoBibreference id or bibkey.34 or ducke1953
biocollectionNoBiocollection id, name or acronym.INPA
datasetNoDataset id or acronym.3 or FOREST1
externalNoFlag to include external ids (Tropicos, IPNI, etc.).1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
levelNoTaxon rank code or string.210 or species
limitNoMaximum number of records to return.100
location_rootNoLocation id/name with descendants included.Amazonas or 10
nameNoTranslatable trait name. Accepts a plain string or a JSON map of language codes to names.{"en":"Height","pt-br":"Altura"}
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
projectNoProject id or acronym.PDBFF or 2
rootNoRoot id for hierarchical queries (taxon or location).120
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitNoTrait id or export_name filter.DBH
validNoWhen 1, return only valid taxon names.1
vernacularNoVernacular 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.

FieldProfilesMeaning
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
scientificNameIDsimple / allDarwin Core taxonomic column: stable identifier of the taxonomic name record, formatted by OpenDataBio as odb:{installation}:taxon:{uuid}.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
taxonRanksimple / allDarwin Core taxonomic column: taxonomic rank of the scientific name.
scientificNameAuthorshipsimple / allDarwin Core taxonomic column: authorship string associated with the scientific name.
namePublishedInsimple / allDarwin Core taxonomic column: bibliographic reference in which the taxonomic name was published.
parentNameUsageIDsimple / allDarwin Core taxonomic column: stable identifier of the parent taxon, formatted by OpenDataBio as odb:{installation}:taxon:{uuid}.
parentNameUsagesimple / allDarwin Core taxonomic column: parent taxon name in the taxonomic hierarchy.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
higherClassificationsimple / allDarwin Core taxonomic column: higher taxonomic classification path for the taxon.
taxonRemarkssimple / allDarwin Core taxonomic column: remarks about the taxon.
taxonomicStatussimple / allDarwin Core taxonomic column: taxonomic status of the name, such as accepted name or synonym.
acceptedNameUsagesimple / allDarwin Core taxonomic column: accepted scientific name when the exported name is not accepted.
acceptedNameUsageIDsimple / allDarwin Core taxonomic column: stable identifier of the accepted taxonomic name, formatted by OpenDataBio as odb:{installation}:taxon:{uuid}.
author_uuidallStable UUID of the person linked as author of an unpublished taxonomic name.
bibreference_uuidallStable UUID of the linked bibliographic reference.
parent_idallInternal numeric identifier of the parent record in a hierarchy.
parent_uuidallStable UUID of the parent record in a hierarchy.
senior_idallInternal numeric identifier of the accepted or senior taxonomic name.
externalKeysallOpenDataBio 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibreferenceNoBibreference id or bibkey.34 or ducke1953
categoriesNoTrait categories JSON list with lang/rank/name/description.[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]
datasetNoDataset id or acronym.3 or FOREST1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
languageNoLanguage 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
limitNoMaximum number of records to return.100
nameNoTranslatable trait name. Accepts a plain string or a JSON map of language codes to names.{"en":"Height","pt-br":"Altura"}
object_typeNoMeasured object type: Individual, Location, Taxon, Voucher, or Media.Individual
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-text search parameter.Silva
tagNoIndividual tag/number/code.A-1234
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitNoTrait id or export_name filter.DBH
typeNoGeneric 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
parent_idsimple / allInternal numeric identifier of the parent record in a hierarchy.
parent_uuidsimple / allStable UUID of the parent record in a hierarchy.
typesimple / allOpenDataBio local type code or type label of the exported resource.
typenamesimple / allOpenDataBio local human-readable name of a trait type.
export_namesimple / allOpenDataBio local stable export name of a trait, used as a public field key in measurements.
unitsimpleOpenDataBio local measurement unit configured for a trait.
range_minsimple / allOpenDataBio local minimum valid value configured for a quantitative trait.
range_maxsimple / allOpenDataBio local maximum valid value configured for a quantitative trait.
link_typesimple / allOpenDataBio local target object type allowed for a link trait.
value_lengthsimple / allOpenDataBio local number of values expected for a spectral trait.
namesimple / allOpenDataBio local name of the exported resource.
descriptionsimple / allOpenDataBio local descriptive text for the exported resource.
objectssimple / allOpenDataBio local list of object types to which a trait can apply.
measurementTypesimple / allDarwin Core MeasurementOrFact column: trait export name or measurement type represented by the measurement.
categoriessimple / allOpenDataBio local list of trait categories, including labels and descriptions when available.
bibreference_idallInternal numeric identifier of the linked bibliographic reference.
bibreference_uuidallStable UUID of the linked bibliographic reference.
measurementUnitallDarwin Core MeasurementOrFact column: unit associated with the measurement value.
measurementMethodallDarwin Core MeasurementOrFact column: method or protocol used to obtain the measurement, i.e. trait definition and metadata
MeasurementTypeBibkeysallOpenDataBio local list of bibliographic keys that support the trait measurement type.
TaggedWithallOpenDataBio 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
namesimple / allOpenDataBio local name of the exported resource.
languageNamesimple / allOpenDataBio local language name associated with a vernacular name.
notessimple / allOpenDataBio local notes associated with the exported resource.
locationsListsimple / allOpenDataBio local human-readable list of locations linked to the record.
taxonsListsimple / allOpenDataBio local human-readable list of taxa linked to the record.
individualsListsimple / allOpenDataBio local human-readable list of individuals linked to the record.
citationsArraysimple / allOpenDataBio local structured list of citations linked to a vernacular name.
languageCodeallOpenDataBio local language code associated with a vernacular name.
taxonsListArrayallOpenDataBio local structured array of taxa linked to the record.
individualsListArrayallOpenDataBio local structured array of individuals linked to the record.
locationsListArrayallOpenDataBio local structured array of locations linked to the record.
variantsListallOpenDataBio local human-readable list of vernacular variants linked to the record.
variantsListArrayallOpenDataBio local structured array of vernacular variants linked to the record.
createdByallOpenDataBio local user or person who created the record.
created_atallTimestamp when the record was created in OpenDataBio.
updated_atallTimestamp 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
bibreferenceNoBibreference id or bibkey.34 or ducke1953
bibreference_idNoBibReference id list for voucher filtering.10,11
biocollectionNoBiocollection id, name or acronym.INPA
biocollection_idNoBiocollection id list for voucher filtering.1,5
collectorNoCollector(s) id, abbreviation, name or email. Use | or ; to separate multiple people; first is main collector.J.Silva|M.Costa
datasetNoDataset id or acronym.3 or FOREST1
date_maxNoFilter records occurring on/before this date (YYYY-MM-DD).2024-12-31
date_minNoFilter records occurring on/after this date (YYYY-MM-DD).2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
main_collectorNoBoolean (1) to filter vouchers by main collector only.1
numberNoCollector number/code (voucher/individual tag when different from individual).1234A
odbrequest_idNoFilter individuals linked to a given request id.12
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitNoTrait id or export_name filter.DBH
vernacularNoVernacular 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
uuidsimple / allStable UUID of the exported record.
individual_uuidsimple / allStable UUID of the linked individual or organism record.
basisOfRecordsimple / allDarwin Core column: basisOfRecord value indicating the general type of biological record.
occurrenceIDsimple / allDarwin 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.
organismIDsimple / allDarwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as odb:{installation}:individual:{uuid}.
organismNamesimple / allDarwin Core column: human-readable label for the organism or individual record.
materialEntityIDsimple / allDarwin 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}.
collectionCodesimple / allDarwin Core column: code, acronym, or name identifying the biological collection.
catalogNumbersimple / allDarwin Core column: catalog number or accession number of the voucher in the biological collection.
typeStatussimple / allDarwin Core column: nomenclatural type status of a voucher specimen.
recordedByMainsimple / allMain collector or observer responsible for the record.
recordNumbersimple / allDarwin Core column: collector or observer record number.
eventDatesimple / allDarwin Core column: date or interval during which the collection, observation, media capture, or occurrence event took place.
recordedBysimple / allDarwin Core column: collectors or observers associated with the record.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
identificationQualifiersimple / allDarwin Core column: qualifier expressing uncertainty or qualification of the identification.
identifiedBysimple / allDarwin Core column: person or people responsible for the taxonomic identification.
dateIdentifiedsimple / allDarwin Core column: date when the taxonomic identification was made.
identificationRemarkssimple / allDarwin Core column: notes associated with the taxonomic identification.
location_idsimple / allInternal numeric identifier of the linked location.
location_uuidsimple / allStable UUID of the linked location.
locationNamesimple / allDarwin Core-compatible location label used by OpenDataBio for the location associated with the record.
higherGeographysimple / allDarwin Core column: higher geographic context for the location, such as parent locations or administrative hierarchy.
decimalLatitudesimple / allDarwin Core column: latitude in decimal degrees, when coordinates are available for distribution.
decimalLongitudesimple / allDarwin Core column: longitude in decimal degrees, when coordinates are available for distribution.
occurrenceRemarkssimple / allDarwin Core column: remarks about the occurrence.
datasetIDsimple / allDarwin 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.
datasetNamesimple / allDarwin Core column: name or title of the dataset governing the exported record.
accessRightssimple / allDarwin 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.
policyCodesimple / allCompact policy code derived from the dataset license and data-use obligations.
dataset_idallInternal numeric identifier of the dataset that governs the exported record.
individual_idallInternal numeric identifier of the linked individual or organism record.
recordedDateallOpenDataBio legacy column equivalent to Darwin Core eventDate. Kept in all exports for backward compatibility; prefer eventDate for interoperability.
scientificNameAuthorshipallDarwin Core taxonomic column: authorship string associated with the scientific name.
taxon_idallInternal numeric identifier of the linked taxonomic name.
taxon_uuidallStable UUID of the linked taxonomic name.
identification_idallInternal numeric identifier of the taxonomic identification linked to the record.
identification_uuidallStable UUID of the taxonomic identification linked to the record.
taxonPublishedStatusallPublication status of the taxonomic name used in the identification.
genusallDarwin Core taxonomic column: genus associated with the exported taxon or identified organism.
georeferenceRemarksallDarwin Core column: notes describing coordinate origin, uncertainty, georeferencing or location details.
relatedLocationsallOther 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
policyUrlallURL where the full dataset policy can be read for the governing dataset or version.
policySummaryallShort 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
get_fileNoWhen 1 and used with userjobs id, returns job prepared file.1
limitNoMaximum number of records to return.100
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
statusNoJob 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
dispatchersimple / allOpenDataBio local job dispatcher class or job type.
statussimple / allOpenDataBio local status of a background job or exported resource.
percentagesimple / allOpenDataBio local progress percentage for a background job.
created_atsimple / allTimestamp when the record was created in OpenDataBio.
affected_ids_countsimple / allOpenDataBio local count of records affected by a background job.
affected_modelsimple / allOpenDataBio local model class or model name affected by a background job.
updated_atallTimestamp when the record was last updated in OpenDataBio.
affected_idsallOpenDataBio local list of record ids affected by a background job.
logallOpenDataBio local text log produced by a background job.

Response example

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

activities (GET)

Lists activity log entries.

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
descriptionNoTranslatable 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"}
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
languageNoLanguage 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
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
log_nameNoActivity log name filter.default
measurementNoActivity filter: measurement id.55
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
subjectNoActivity filter: subject type (class basename).Individual
subject_idNoActivity filter: subject id.12
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
voucherNoVoucher 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
log_namesimple / allOpenDataBio local activity log name.
descriptionsimple / allOpenDataBio local descriptive text for the exported resource.
subject_typesimple / allOpenDataBio local model class of the object recorded in an activity log entry.
subject_namesimple / allOpenDataBio local human-readable name of the object recorded in an activity log entry.
subject_idsimple / allInternal numeric identifier of the object recorded in an activity log entry.
modified_bysimple / allOpenDataBio local user who modified the activity subject.
propertiessimple / allOpenDataBio local structured activity properties, usually encoded as JSON.
created_atsimple / allTimestamp when the record was created in OpenDataBio.
updated_atsimple / allTimestamp 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
datasetNoDataset id or acronym.3 or FOREST1
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
job_idNoJob id to reuse affected ids or filter results from a job.1024
languageNoLanguage 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
limitNoMaximum number of records to return.100
nameNoTranslatable trait name. Accepts a plain string or a JSON map of language codes to names.{"en":"Height","pt-br":"Altura"}
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
searchNoFull-text search parameter.Silva
traitNoTrait 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
namesimple / allOpenDataBio local name of the exported resource.
descriptionsimple / allOpenDataBio local descriptive text for the exported resource.
countsallOpenDataBio 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).

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
brahms_levelNoBRAHMS export level. Use individual for one row per individual, or voucher for one row per voucher linked to matching individuals.individual or voucher
datasetNoDataset id or acronym.3 or FOREST1
date_maxNoFilter records occurring on/before this date (YYYY-MM-DD).2024-12-31
date_minNoFilter records occurring on/after this date (YYYY-MM-DD).2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
habitattxt_traitsNoMeasurement 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_headerNoBoolean, 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_vernacularsNoWhen 1, BRAHMS vernacular also includes names linked to the individual taxon.0
include_vernacularsNoWhen 1, includes vernacular names in BRAHMS output.1
include_voucher_individualsNoFor BRAHMS individual-level exports with a dataset filter, include individuals outside the dataset when they have vouchers in the requested dataset.1
job_idNoJob id to reuse affected ids or filter results from a job.1024
langNoLanguage 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
limitNoMaximum number of records to return.100
locationNoLocation id or name.Parcela 25ha or 55
location_rootNoLocation id/name with descendants included.Amazonas or 10
locnotes_traitsNoMeasurement 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_headerNoBoolean, 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_datasetNoDataset id/name list used to limit measurements summarized in BRAHMS descriptions.Flora-INPA
odbrequest_idNoFilter individuals linked to a given request id.12
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
plantdesc_traitsNoMeasurement 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_headerNoBoolean, or comma-separated boolean list, controlling whether plantdesc trait export_name or JSON key is used as a prefix.1 or 1,0,1
projectNoProject id or acronym.PDBFF or 2
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
tagNoIndividual tag/number/code.A-1234
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon id/name including descendants.Lauraceae
traitNoTrait id or export_name filter.DBH
vernacularNoVernacular 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.

FieldProfilesMeaning
odbUuidsimple / allBRAHMS/INPA export column: OpenDataBio UUID of the exported source record.
collectorsimple / allBRAHMS/INPA export column for the main collector name or abbreviation.
numbersimple / allRecord, collection, or BRAHMS number value; the exact meaning depends on the endpoint.
addcollsimple / allBRAHMS/INPA export column for additional collectors.
collddsimple / allBRAHMS/INPA export column for collection day.
collmmsimple / allBRAHMS/INPA export column for collection month.
collyysimple / allBRAHMS/INPA export column for collection year.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
genussimple / allDarwin Core taxonomic column: genus associated with the exported taxon or identified organism.
sp1simple / allBRAHMS/INPA export column for the first species epithet field.
sp2simple / allBRAHMS/INPA export column for the second epithet or infraspecific name field.
detbysimple / allBRAHMS/INPA export column for the person who identified the specimen or individual.
countrysimple / allCountry name or code associated with a location.
majorareasimple / allBRAHMS/INPA export column for the major geographic area.
minorareasimple / allBRAHMS/INPA export column for the minor geographic area.
gazetteersimple / allBRAHMS/INPA export column for the gazetteer or named locality.
locnotessimple / allBRAHMS/INPA export column for locality notes, related locations, and local position information.
habitattxtsimple / allBRAHMS/INPA export column for habitat text, usually derived from measurements of the current location when available.
latsimple / allBRAHMS/INPA export column: latitude value formatted for the BRAHMS exchange table.
NSsimple / allBRAHMS/INPA export column indicating whether latitude is north or south.
longsimple / allBRAHMS/INPA export column: longitude value formatted for the BRAHMS exchange table.
EWsimple / allBRAHMS/INPA export column indicating whether longitude is east or west.
llunitsimple / allBRAHMS/INPA export column describing the latitude/longitude unit or format.
altsimple / allBRAHMS/INPA export column for elevation or altitude.
plantdescsimple / allBRAHMS/INPA export column for plant description, derived from individual or voucher measurements and notes.
vernacularsimple / allBRAHMS/INPA export column for vernacular names.
projectsimple / allBRAHMS/INPA export column for project name, acronym, or code.
campoallBRAHMS/INPA export column used by local workflows to identify the field or source context.
accessionallBRAHMS/INPA export column for accession or collection accession value.
prefixallBRAHMS/INPA export column for collector number prefix.
suffixallBRAHMS/INPA export column for collector number suffix.
initialallBRAHMS/INPA export column for collector initials or local initials field.
detstatusallBRAHMS/INPA export column for determination status.
rank1allBRAHMS/INPA export column for infraspecific rank.
detddallBRAHMS/INPA export column for identification day.
detmmallBRAHMS/INPA export column for identification month.
detyyallBRAHMS/INPA export column for identification year.
alt1allBRAHMS/INPA export column for secondary elevation or altitude value.
dupsallBRAHMS/INPA export column for duplicate specimen information.

identification-histories (GET)

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

ParameterRequiredDescriptionExample
idNoSingle id or comma-separated list to filter or target records.1,2,3
biocollectionNoBiocollection id, name or acronym.INPA
date_maxNoFilter records occurring on/before this date (YYYY-MM-DD).2024-12-31
date_minNoFilter records occurring on/after this date (YYYY-MM-DD).2020-01-01
fieldsNoComma separated list of the fields to include in the response or special words all/simple/raw, default to simpleid,scientificName or all
identification_idNoIdentification 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
individualNoIndividual id, uuid or organismID (fullname).4521 or 2ff0e884-3d33
individual_idNoIndividual id list for occurrence queries.12,55,90
job_idNoJob id to reuse affected ids or filter results from a job.1024
limitNoMaximum number of records to return.100
offsetNoThe starting position of the record set to be exported. Used together with limit to limit results.10000
personNoPerson id, abbreviation, full name or email (supports lists with | or ;).J.Silva|M.Costa
save_jobNoIf 1, save the results as file to download later via userjobs + get_file = T1
sourceNoSource label for generated or imported records.api
taxonNoTaxon id or canonical full name list.Licaria cannela or 456,789
taxon_rootNoTaxon 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.

FieldProfilesMeaning
idsimple / allInternal numeric identifier of the exported record in this OpenDataBio installation.
identification_idsimple / allInternal numeric identifier of the taxonomic identification linked to the record.
identification_uuidsimple / allStable UUID of the taxonomic identification linked to the record.
individual_idsimple / allInternal numeric identifier of the linked individual or organism record.
individual_uuidsimple / allStable UUID of the linked individual or organism record.
organismIDsimple / allDarwin Core column: stable identifier of the organism/individual, formatted by OpenDataBio as odb:{installation}:individual:{uuid}.
organismNamesimple / allDarwin Core column: human-readable label for the organism or individual record.
taxon_idsimple / allInternal numeric identifier of the linked taxonomic name.
taxon_uuidsimple / allStable UUID of the linked taxonomic name.
scientificNamesimple / allDarwin Core taxonomic column: scientific name associated with the record at the time of export.
familysimple / allDarwin Core taxonomic column: family associated with the exported taxon or identified organism.
identificationQualifiersimple / allDarwin Core column: qualifier expressing uncertainty or qualification of the identification.
identifiedBysimple / allDarwin Core column: person or people responsible for the taxonomic identification.
dateIdentifiedsimple / allDarwin Core column: date when the taxonomic identification was made.
identificationBiocollectionsimple / allBiocollection used as a reference for the identification, when applicable.
identificationBiocollectionReferencesimple / allCatalog or reference number in the biocollection used for identification.
identificationRemarkssimple / allDarwin Core column: notes associated with the taxonomic identification.
replaced_atsimple / allTimestamp or date when an identification history row was replaced.
replacedByNamesimple / allOpenDataBio local name of the identification that replaced this identification history row.
sourcesimple / allOpenDataBio local source label for the record or identification history row.
scientificNameAuthorshipallDarwin Core taxonomic column: authorship string associated with the scientific name.
taxonPublishedStatusallPublication status of the taxonomic name used in the identification.
genusallDarwin Core taxonomic column: genus associated with the exported taxon or identified organism.
identifiersallOpenDataBio local list of people responsible for a taxonomic identification.
modifierallOpenDataBio local identification qualifier/modifier code stored with an identification history row.
dateallOpenDataBio local date associated with the exported record; the exact event depends on the endpoint.
biocollection_idallInternal numeric identifier of the linked biological collection.
biocollection_uuidallStable UUID of the linked biological collection.
replaced_byallInternal numeric identifier of the identification history row that replaced this row.
source_idallOpenDataBio local identifier of the source record or source process.
source_payloadallOpenDataBio local structured payload from the source process, usually encoded as JSON.
created_atallTimestamp when the record was created in OpenDataBio.
updated_atallTimestamp when the record was last updated in OpenDataBio.