University of Helsinki Taxa API

openapi: 3.2.0
info:
  title: Laji Taxa API
  description: '## Authentication


    This API requires an **Access Token**.'
  version: '1'
  contact: {}
servers:
- url: https://api.laji.fi
tags:
- name: Taxa
paths:
  /taxa/search:
    get:
      operationId: TaxaController_search
      parameters:
      - name: query
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: false
        in: query
        description: Limit the number of results
        schema:
          default: 10
          type: number
      - name: checklist
        required: false
        in: query
        description: Include taxa from the specified checklists (defaults to FinBIF master checklist)
        schema:
          type: string
      - name: taxonSets
        required: false
        in: query
        description: Filter based on taxon set(s). Multiple values are separated by a comma (,)
        schema:
          type: string
      - name: informalTaxonGroups
        required: false
        in: query
        description: Search taxa from specified informal taxon group(s). Multiple values are separated by a comma (,). An exclamation mark in the beginning of a matches exclusively.
        schema:
          type: string
      - name: includeHidden
        required: false
        in: query
        description: Include hidden taxa in the response
        schema:
          default: false
          type: boolean
      - name: nameTypes
        required: false
        in: query
        description: Filter by type of the matching name (e.g., MX.vernacularName, MX.hasMisappliedName). Multiple values are separated by a comma (,). An exclamation mark in the beginning of a matches exclusively.
        schema:
          type: string
      - name: languages
        required: false
        in: query
        description: Filters by the language of the matching name. Multiple values can be specified, separated by commas (,). This applies only to name types that are available in multiple languages (e.g., MX.vernacularName) and does not apply to scientific names.
        schema:
          type: string
      - name: matchType
        required: false
        in: query
        description: 'Default: All match types; exact = exact matches, partial = partially matching, likely = fuzzy matching. Multiple values are separated by a comma (,)'
        schema:
          type: string
      - name: species
        required: false
        in: query
        description: 'true: Will include only "lower taxa" (species, subspecies, aggregates, ...)

          false: Will only include "higher taxa" (genus and above)'
        schema:
          type: boolean
      - name: finnish
        required: false
        in: query
        description: 'true: Will include only finnish taxa.

          false: Will exclude finnish taxa.'
        schema:
          type: boolean
      - name: invasiveSpecies
        required: false
        in: query
        description: Filter to include only invasive species
        schema:
          type: boolean
      - name: selectedFields
        required: false
        in: query
        description: Multiple values are separated by a comma (,)
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/LajiBackendTaxonSearchResponse'
                  '@context':
                    type: string
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '406':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '422':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '500':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
      security:
      - Access token: []
      - Lang: []
      - Person token: []
      summary: Search taxons by name
      tags:
      - Taxa
  /taxa:
    get:
      operationId: TaxaController_getPage
      parameters:
      - name: checklist
        required: false
        in: query
        description: Include taxa from the specified checklists (defaults to FinBIF master checklist)
        schema:
          default: MR.1
          type: string
      - name: page
        required: false
        in: query
        schema:
          default: 1
          type: integer
      - name: pageSize
        required: false
        in: query
        schema:
          default: 20
          type: integer
      - name: informalTaxonGroups
        required: false
        in: query
        description: Filter based on given informal groups. Multiple values are separated by a comma (,).
        schema:
          type: string
      - name: id
        required: false
        in: query
        description: Filter by comma separated ids
        schema:
          type: string
      - name: selectedFields
        required: false
        in: query
        description: 'Select fields to include in the result. Multiple values are separated by a comma (,). Allows any value in the

          schema. If the response is a page-like object (has "results"), it allows any field in the results'' schema'
        schema:
          type: string
      - name: checklistVersion
        required: false
        in: query
        description: Checklist version to be used. Defaults to the latest version.
        schema:
          default: current
          type: string
          enum:
          - current
          - MR.424
          - MR.425
          - MR.426
          - MR.427
          - MR.428
          - MR.484
      - name: invasiveSpecies
        required: false
        in: query
        description: 'true: Will include only invasive taxa.

          false: Will exclude invasive taxa.'
        schema:
          type: boolean
      - name: finnish
        required: false
        in: query
        description: 'true: Will include only finnish taxa.

          false: Will exclude finnish taxa.'
        schema:
          type: boolean
      - name: includeMedia
        required: false
        in: query
        description: Include media objects in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeDescriptions
        required: false
        in: query
        description: Include description objects in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeRedListEvaluations
        required: false
        in: query
        description: Include red list evaluations in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeHidden
        required: false
        in: query
        description: 'true: Will show hidden taxa

          false: Hidden taxa are skipped and their non-hidden children raised up in the tree.'
        schema:
          default: false
          type: boolean
      - name: sortOrder
        required: false
        in: query
        description: 'Sorting field of the species (one of ''taxonomic'' | ''scientificName'' | ''finnishName'') and optional sort order ''desc'' | ''asc''.

          Order defaults to ''asc''. The sort field and order are separated by a space character.


          Defaults to ''taxonomic'''
        schema:
          default: taxonomic
          type: string
      - name: parentTaxonId
        required: false
        in: query
        description: Filter based on parent taxon id
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  currentPage:
                    type: integer
                  pageSize:
                    type: integer
                  total:
                    type: integer
                  lastPage:
                    type: integer
                  prevPage:
                    type: integer
                  nextPage:
                    type: integer
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/LajiBackendTaxon'
                required:
                - currentPage
                - pageSize
                - total
                - lastPage
                - results
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '401':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '403':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '404':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '406':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '422':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
        '500':
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                  localized:
                    type: boolean
      security:
      - Access token: []
      - Lang: []
      - Person token: []
      summary: Get a page of taxa
      tags:
      - Taxa
    post:
      operationId: TaxaController_getPageWithFilters
      parameters:
      - name: checklist
        required: false
        in: query
        description: Include taxa from the specified checklists (defaults to FinBIF master checklist)
        schema:
          default: MR.1
          type: string
      - name: page
        required: false
        in: query
        schema:
          default: 1
          type: integer
      - name: pageSize
        required: false
        in: query
        schema:
          default: 20
          type: integer
      - name: selectedFields
        required: false
        in: query
        description: 'Select fields to include in the result. Multiple values are separated by a comma (,). Allows any value in the

          schema. If the response is a page-like object (has "results"), it allows any field in the results'' schema'
        schema:
          type: string
      - name: checklistVersion
        required: false
        in: query
        description: Checklist version to be used. Defaults to the latest version.
        schema:
          default: current
          type: string
          enum:
          - current
          - MR.424
          - MR.425
          - MR.426
          - MR.427
          - MR.428
          - MR.484
      - name: includeMedia
        required: false
        in: query
        description: Include media objects in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeDescriptions
        required: false
        in: query
        description: Include description objects in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeRedListEvaluations
        required: false
        in: query
        description: Include red list evaluations in the response. Defaults to false.
        schema:
          default: false
          type: boolean
      - name: includeHidden
        required: false
        in: query
        description: 'true: Will show hidden taxa

          false: Hidden taxa are skipped and their non-hidden children raised up in the tree.'
        schema:
          default: false
          type: boolean
      - name: sortOrder
        required: false
        in: query
        description: 'Sorting field of the species (one of ''taxonomic'' | ''scientificName'' | ''finnishName'') and optional sort order ''desc'' | ''asc''.

          Order defaults to ''asc''. The sort field and order are separated by a space character.


          Defaults to ''taxonomic'''
        schema:
          default: taxonomic
          type: string
      - name: parentTaxonId
        required: false
        in: query
        description: Filter based on parent taxon id
        schema:
          type: string
      requestBody:
        required: false
        description: "\nThe request body is a JSON object where each property represents a filter.\n\nProperties are dot-separated (e.g., 'field.subfield') and correspond to the fields of taxon results. For array fields, the filter is done against each array item, so the dot-separated pointer shouldn't include array item path (if 'subfield' is an array that has property 'subsubfield', the pointer would be 'field.subfield.subsubfield').\n\nFor array fields, the dot notation allows filtering by nested properties.\n\nEach filter value can be one of the following types:\n\n- **boolean**: To filter by true/false values.\n- **string**: To filter by exact string matches. Adding an excalamation mark (!) in the beginning makes the filter work as a \"must not\" operator,\n- **array of strings**: To filter by multiple string values as an \"OR\" operator. Supports also exclamation mark syntax\n\nExample for syntax:\n\n```\n{\n  \"species\": true,                               // Matches taxa that have \"species\": true\n  \"informalTaxonGroups\": \"MVL.1\",                // Matches taxa with informalTaxonGoup MVL.1\n  \"multimedia.author\": \"somebody\",               // Matches taxa with any multimedia item having author \"somebody\"\n  \"taxonRank\": [\"MX.genus\", \"MX.subGenus\"]       // Matches taxa that are of rank genus or sub-genus\n  \"secureLevel\": \"!MX.secureLevelNoShow\"         // Matches everything but taxa with MX.secureLevelNoShow\n}\n```\n"
        content:
          application/json:
            schema:
              type: object
              properties:
                qname:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                id:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                uri:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                isPartOf:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                isPartOfNonHidden:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                parents:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                nonHiddenParents:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                parentsIncludeSelf:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                nonHiddenParentsIncludeSelf:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                hiddenTaxon:
                  type: boolean
                nameAccordingTo:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                taxonRank:
                  oneOf:
                  - type: string
                    description: Qname identifier
                  - type: array
                    items:
                      type: string
                      description: Qname identifier
                scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                scientificNameDisplayName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                cursiveName:
                  type: boolean
                typeSpecimenURI:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonymNames:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.cursiveName:
                  type: boolean
                basionyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                basionyms.hasBold:
                  type: boolean
                objectiveSynonyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.cursiveName:
                  type: boolean
                objectiveSynonyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                objectiveSynonyms.hasBold:
                  type: boolean
                subjectiveSynonyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.cursiveName:
                  type: boolean
                subjectiveSynonyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                subjectiveSynonyms.hasBold:
                  type: boolean
                homotypicSynonyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.cursiveName:
                  type: boolean
                homotypicSynonyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                homotypicSynonyms.hasBold:
                  type: boolean
                heterotypicSynonyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.cursiveName:
                  type: boolean
                heterotypicSynonyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                heterotypicSynonyms.hasBold:
                  type: boolean
                synonyms.id:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.scientificName:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.scientificNameAuthorship:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.vernacularName.fi:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.vernacularName.sv:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.vernacularName.en:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.taxonRank:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.cursiveName:
                  type: boolean
                synonyms.notes:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                synonyms.bold.bins:
                  oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                

# --- truncated at 32 KB (822 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/university-of-helsinki/refs/heads/main/openapi/university-of-helsinki-taxa-api-openapi.yml