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

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

Fields (simple): id, bibkey, year, author, title, doi, url, bibtex

Fields (all): id, bibkey, year, author, title, doi, url, bibtex

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

Fields (simple): id, acronym, name, irn

Fields (all): id, acronym, name, irn, country, city, address

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 files (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
file_nameNoDataset version file name to download.2_Organisms.csv
has_versionsNoWhen 1, returns only datasets that have public versions.1
include_urlNoWhen 1 with list_versions, include file download 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

Fields returned

Fields (simple): id, name, title, projectName, description, notes, contactEmail, taggedWidth, uuid

Fields (all): id, name, title, projectName, notes, privacyLevel, policy, description, measurements_count, contactEmail, taggedWidth, uuid

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

Fields (simple): id, basisOfRecord, organismID, recordedByMain, recordNumber, recordedDate, family, scientificName, identificationQualifier, identifiedBy, dateIdentified, locationName, locationParentName, decimalLatitude, decimalLongitude, x, y, gx, gy, angle, distance, datasetName

Fields (all): id, basisOfRecord, organismID, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, scientificNameAuthorship, taxonPublishedStatus, genus, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, identificationBiocollection, identificationBiocollectionReference, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, locationParentName, x, y, gx, gy, angle, distance, organismRemarks, datasetName, uuid

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

Fields (simple): id, individual_id, basisOfRecord, occurrenceID, organismID, recordedDate, locationName, higherGeography, decimalLatitude, decimalLongitude, x, y, angle, distance, minimumElevation, occurrenceRemarks, scientificName, family, datasetName

Fields (all): id, individual_id, basisOfRecord, occurrenceID, organismID, scientificName, family, recordedDate, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, x, y, angle, distance, minimumElevation, occurrenceRemarks, organismRemarks, datasetName

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

Fields (simple): id, basisOfRecord, locationName, adm_level, country_adm_level, x, y, startx, starty, distance_to_search, parent_id, parentName, higherGeography, footprintWKT, locationRemarks, decimalLatitude, decimalLongitude, georeferenceRemarks, geodeticDatum

Fields (all): id, basisOfRecord, locationName, adm_level, country_adm_level, x, y, startx, starty, distance_to_search, parent_id, parentName, higherGeography, footprintWKT, locationRemarks, decimalLatitude, decimalLongitude, georeferenceRemarks, geodeticDatum

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

Fields (simple): id, basisOfRecord, measured_type, measured_id, measurementType, measurementValue, measurementUnit, measurementDeterminedBy, measurementDeterminedDate, scientificName, datasetName, family, sourceCitation

Fields (all): id, basisOfRecord, measured_type, measured_id, measurementType, measurementValue, measurementUnit, measurementDeterminedDate, measurementDeterminedBy, measurementRemarks, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, measurementMethod, sourceCitation, measurementLocationId, measurementParentId, decimalLatitude, decimalLongitude

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "basisOfRecord": "MeasurementsOrFact",
            "measured_type": "App\\Models\\Individual",
            "measured_id": 86947,
            "measurementType": "treeDbh",
            "measurementValue": 13,
            "measurementUnit": "cm",
            "measurementDeterminedDate": "1979-11-14",
            "measurementDeterminedBy": "Menezes, J.F. | Bahia, R.P. | Lima, J. | Santos, R.M. | Ferreira, A.J.C. | Cardoso, Romeu M.",
            "measurementRemarks": null,
            "resourceRelationship": null,
            "resourceRelationshipID": "1202-1371_Menezes_1979",
            "relationshipOfResource": "measurement of",
            "scientificName": "Paramachaerium ormosioides",
            "family": "Fabaceae",
            "datasetName": "Censos 01 - PDBFF-FITO ForestPlots - 1979-1980",
            "measurementMethod": "Name: Diameter at breast height - DBH | Definition:Diameter at breast height,, i.e. ca. 1.3 meters from the base of the trunk",
            "sourceCitation": null,
            "measurementLocationId": 28280,
            "measurementParentId": null,
            "decimalLatitude": -2.40371599,
            "decimalLongitude": -59.87090972
        }
    ]
}

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

Fields (simple): id, model_type, model_id, basisOfRecord, recordedBy, recordedDate, dwcType, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, projectName, taggedWith, accessRights, license, file_name, file_url, citation, uuid

Fields (all): id, model_type, model_id, basisOfRecord, recordedBy, recordedDate, dwcType, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, projectName, taggedWith, accessRights, bibliographicCitation, license, file_name, file_url, citation, uuid, bibtex, userName, created_at

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

Fields (simple): id, full_name, abbreviation, emailAddress, institution, notes

Fields (all): id, full_name, abbreviation, emailAddress, institution, notes

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

Fields (simple): id, acronym, name, description

Fields (all): id, acronym, name, description, pages, urls, created_at, updated_at

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

Fields (simple): id, parent_id, author_id, scientificName, taxonRank, scientificNameAuthorship, namePublishedIn, parentName, family, taxonRemarks, taxonomicStatus, scientificNameID, basisOfRecord

Fields (all): id, senior_id, parent_id, author_id, scientificName, taxonRank, scientificNameAuthorship, namePublishedIn, parentName, family, higherClassification, taxonRemarks, taxonomicStatus, acceptedNameUsage, acceptedNameUsageID, parentNameUsage, scientificNameID, basisOfRecord

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/nameen or 1 or english or portuguese
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

Fields (simple): id, type, typename, export_name, unit, range_min, range_max, link_type, value_length, name, description, objects, measurementType, categories

Fields (all): id, type, typename, export_name, measurementType, measurementUnit, range_min, range_max, link_type, value_length, name, description, objects, measurementMethod, MeasurementTypeBibkeys, TaggedWith, categories

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

Fields (simple): id, name, languageName, notes, locationsList, taxonsList, individualsList, citationsArray

Fields (all): id, name, languageName, languageCode, notes, taxonsList, taxonsListArray, individualsList, individualsListArray, locationsList, locationsListArray, variantsList, variantsListArray, citationsArray, createdBy, created_at, updated_at

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "name": "itaúba-preta",
            "languageName": "Portuguese",
            "languageCode": "pt-br",
            "notes": null,
            "taxonsList": "Mezilaurus duckei",
            "taxonsListArray": [
                {
                    "id": 19774,
                    "scientificName": "Mezilaurus duckei",
                    "family": "Lauraceae"
                }
            ],
            "individualsList": "7739_Macedo_2023",
            "individualsListArray": [
                {
                    "id": 510747,
                    "uuid": "c75d9233-f437-11ef-b90b-9cb654b86224",
                    "organismId": "7739_Macedo_2023",
                    "scientificName": "Mezilaurus duckei",
                    "family": "Lauraceae"
                }
            ],
            "locationsList": null,
            "locationsListArray": [],
            "variantsList": "itaúba",
            "variantsListArray": [
                {
                    "id": 2,
                    "name": "itaúba",
                    "languageName": "Tupi",
                    "languageCode": "tup"
                }
            ],
            "citationsArray": [
                {
                    "id": 2,
                    "citation": "ita = pedra; uba = árvore;  preta em referência a cor da madeira",
                    "bibreference_id": null,
                    "bibreference_name": null,
                    "notes": null,
                    "type": "etimology",
                    "createdBy": "example"
                }
            ],
            "createdBy": "example",
            "created_at": "2025-12-15T20:17:16.000000Z",
            "updated_at": "2025-12-15T21:04:53.000000Z"
        }
    ]
}

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

Fields (simple): id, individual_id, basisOfRecord, occurrenceID, organismID, collectionCode, catalogNumber, typeStatus, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, locationName, decimalLatitude, decimalLongitude, occurrenceRemarks, datasetName

Fields (all): id, individual_id, basisOfRecord, occurrenceID, organismID, collectionCode, catalogNumber, typeStatus, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, scientificNameAuthorship, taxonPublishedStatus, genus, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, occurrenceRemarks, datasetName, uuid

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

Fields (simple): id, dispatcher, status, percentage, created_at, affected_ids, affected_model

Fields (all): id, dispatcher, status, percentage, created_at, updated_at, affected_ids, affected_model, log

Response example

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 23652,
            "dispatcher": "App\\Jobs\\BatchUpdateIndividuals",
            "status": "Success",
            "percentage": "100%",
            "created_at": "2025-12-10T14:36:25.000000Z",
            "updated_at": "2025-12-10T14:36:28.000000Z",
            "affected_ids": [
                86136,
                57362,
                85053,
                72256,
                74543
            ],
            "affected_model": "App\\Models\\Individual",
            "log": "[]"
        }
    ]
}

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/nameen or 1 or english or portuguese
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

Fields (simple): id, log_name, description, subject_type, subject_name, subject_id, modified_by, properties, created_at, updated_at

Fields (all): id, log_name, description, subject_type, subject_id, subject_name, modified_by, properties, created_at, updated_at

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/nameen or 1 or english or portuguese
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

Fields (simple): id, name, description

Fields (all): id, name, description, counts

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
            }
        }
    ]
}