---
title: "Get a taxonomy names report by taxon"
method: POST
path: "/taxonomy/name_report"
tags: ["Taxonomy"]
---

# Get a taxonomy names report by taxon

`POST /taxonomy/name_report`

Get a taxonomy names report, including common names and other synonyms, in JSON format.

## Request body

- V2TaxonomyMetadataRequest
  - `taxons` string[]
  - `returned_content` 'COMPLETE' | 'TAXIDS' | 'METADATA'
  - `page_size` integer
  - `include_tabular_header` 'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'
  - `page_token` string
  - `table_format` 'SUMMARY'
  - `children` boolean
  - `ranks` V2reportsRankType[]

## Response `200`

A successful response

- V2reportsTaxonomyNamesDataReportPage
  - `reports` V2reportsTaxonomyNamesReportMatch[]
    - `taxonomy` V2reportsTaxonomyNamesDescriptor
      - `tax_id` string, uint64
      - `rank` 'NO_RANK' | 'SUPERKINGDOM' | 'DOMAIN' | 'REALM' | 'KINGDOM' | 'SUBKINGDOM' | 'SUPERPHYLUM' | 'SUBPHYLUM' | 'PHYLUM' | 'CLADE' | 'SUPERCLASS' | 'CLASS' | 'SUBCLASS' | 'INFRACLASS' | 'COHORT' | 'SUBCOHORT' | 'SUPERORDER' | 'ORDER' | 'SUBORDER' | 'INFRAORDER' | 'PARVORDER' | 'SUPERFAMILY' | 'FAMILY' | 'SUBFAMILY' | 'GENUS' | 'SUBGENUS' | 'SPECIES_GROUP' | 'SPECIES_SUBGROUP' | 'SPECIES' | 'SUBSPECIES' | 'TRIBE' | 'SUBTRIBE' | 'FORMA' | 'VARIETAS' | 'STRAIN' | 'SECTION' | 'SUBSECTION' | 'PATHOGROUP' | 'SUBVARIETY' | 'GENOTYPE' | 'SEROTYPE' | 'ISOLATE' | 'MORPH' | 'SERIES' | 'FORMA_SPECIALIS' | 'SEROGROUP' | 'BIOTYPE' | 'ACELLULAR_ROOT' | 'CELLULAR_ROOT'
      - `current_scientific_name` V2reportsNameAndAuthority
        - `name` string
        - `authority` string
        - `type_strains` V2reportsTaxonomyTypeMaterial[]
          - `type_strain_name` string
          - `type_strain_id` string
          - `bio_collection_id` string
          - `bio_collection_name` string
          - `collection_type` V2reportsCollectionType[]
          - `type_class` string
        - `curator_synonym` string
        - `homotypic_synonyms` V2reportsNameAndAuthority[]
        - `heterotypic_synonyms` V2reportsNameAndAuthority[]
        - `other_synonyms` V2reportsNameAndAuthority[]
        - `informal_names` string[]
        - `basionym` V2reportsNameAndAuthority — recursive
        - `publications` V2reportsNameAndAuthorityPublication[]
          - `name` string
          - `citation` string
          - `pmid` string, uint64
        - `notes` V2reportsNameAndAuthorityNote[]
          - `name` string
          - `note` string
          - `note_classifier` 'no_authority_classifier' | 'effective_name' | 'nomen_approbbatum' | 'ictv_accepted'
        - `formal` boolean
      - `group_name` string
      - `curator_common_name` string
      - `other_common_names` string[]
      - `general_notes` string[]
      - `links_from_type` string
      - `citations` V2reportsTaxonomyNamesDescriptorCitation[]
        - `full_citation` string
        - `short_citation` string
        - `pmid` string, uint64
      - `current_scientific_name_is_formal` boolean
    - `query` string[]
    - `warning` V2reportsWarning
      - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON'
      - `reason` string
      - `message` string
      - `replaced_id` V2reportsWarningReplacedId
        - `requested` string
        - `returned` string
      - `unrecognized_identifier` string
    - `errors` V2reportsError[]
      - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
      - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
      - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
      - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
      - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
      - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
      - `reason` string
      - `message` string
      - `invalid_identifiers` string[]
  - `messages` V2reportsMessage[]
    - `error` V2reportsError
      - `assembly_error_code` 'UNKNOWN_ASSEMBLY_ERROR_CODE' | 'INVALID_BIOPROJECT_IDS' | 'NO_ASSEMBLIES_FOR_BIOPROJECTS' | 'INVALID_TAXON' | 'MISSING_SEARCH_FIELD' | 'INVALID_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_BIOSAMPLE_IDS' | 'NO_ASSEMBLIES_FOR_ASSEMBLY_NAMES' | 'INVALID_WGS_ACCESSIONS' | 'NO_ASSEMBLIES_FOR_WGS_ACCESSIONS'
      - `gene_error_code` 'UNKNOWN_GENE_ERROR_CODE' | 'INCOMPLETE_LOOKUP_SYMBOL' | 'INVALID_TAXON_GENE_ARGUMENT'
      - `organelle_error_code` 'UNKNOWN_ORGANELLE_ERROR_CODE' | 'INVALID_ORGANELLE_TAXON' | 'NO_ORGANELLES_FOR_ACCESSION'
      - `virus_error_code` 'UNKNOWN_VIRUS_ERROR_CODE'
      - `taxonomy_error_code` 'UNKNOWN_TAXONOMY_ERROR_CODE' | 'INVALID_TAXONOMY_TAXON'
      - `sequence_error_code` 'UNKNOWN_SEQUENCE_ERROR_CODE' | 'INVALID_SEQUENCE_ACCESSION'
      - `reason` string
      - `message` string
      - `invalid_identifiers` string[]
    - `warning` V2reportsWarning
      - `gene_warning_code` 'UNKNOWN_GENE_WARNING_CODE' | 'ACCESSION_VERSION_MISMATCH' | 'REPLACED_GENE_ID' | 'DISCONTINUED_GENE_ID' | 'UNRECOGNIZED_GENE_ID' | 'UNRECOGNIZED_GENE_SYMBOL' | 'UNRECOGNIZED_ACCESSION' | 'UNRECOGNIZED_TAX_TOKEN' | 'NO_GENE_ANNOTATION_FOUND' | 'ABOVE_SPECIES_TAXON'
      - `reason` string
      - `message` string
      - `replaced_id` V2reportsWarningReplacedId
        - `requested` string
        - `returned` string
      - `unrecognized_identifier` string
  - `total_count` integer
  - `next_page_token` string

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/ncats/apis/ncbi-datasets-api.md) · [All operations](https://skmtc.net/ncats/apis/ncbi-datasets-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ncats/ncbi-datasets-api/revisions/e5d4400c8e5d/schema)