---
title: "Get Related Region"
method: GET
path: "/regions/{region_id}/related"
tags: ["region"]
---

# Get Related Region

`GET /regions/{region_id}/related`

## Request

- Base URL: `/v3_0` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v3_0/regions/{region_id}/related`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fzj-inm1-bda/apis/siibra-api/docs/regions/:region_id/related/get.ts> (a function with typed inputs; its response is checked against the schema)

HTTP get_related_regions of the specified region

## Path parameters

- `region_id` string, required

## Query parameters

- `parcellation_id` string, required
- `page` integer
- `size` integer

## Response `200`

Successful Response

- PageRegionRelationAsmtModel
  - `items` RegionRelationAsmtModel[], required
    - `@type` string, required
    - `qualification` 'EXACT' | 'OVERLAPS' | 'CONTAINED' | 'CONTAINS' | 'APPROXIMATE' | 'HOMOLOGOUS' | 'OTHER_VERSION', required: Qualification Exactly match to Qualification in siibra.core.relation_quantification.Quantification
    - `query_structure` ParcellationEntityVersionModel, required: ParcellationEntityVersionModel
      - `@type` string, required
      - `@context` VocabModel
        - `@vocab` string, required
      - `@id` string, required: Metadata node identifier.
      - `hasAnnotation` HasAnnotation
        - `@context` VocabModel
          - `@vocab` string, required
        - `bestViewPoint` BestViewPoint
          - `@context` VocabModel
            - `@vocab` string, required
          - `coordinateSpace` unknown, required
          - `coordinates` ApiModelsOpenmindsSANDSV3AtlasParcellationEntityVersionCoordinates[], required: Structured information on a quantitative value.
            - `@context` VocabModel
              - …
            - `typeOfUncertainty` unknown
            - `uncertainty` number[]: Quantitative value range defining the uncertainty of a measurement.
            - `unit` unknown
            - `value` number, required: Entry for a property.
        - `criteria` unknown
        - `criteriaQualityType` unknown, required
        - `displayColor` string: Preferred coloring.
        - `inspiredBy` unknown[]: Reference to an inspiring element.
          - unknown
        - `internalIdentifier` string, required: Term or code that identifies someone or something within a particular product.
        - `laterality` unknown[]: Differentiation between a pair of lateral homologous parts of the body.
          - unknown
        - `visualizedIn` unknown
      - `hasParent` unknown[]: Reference to a parent object or legal person.
        - unknown
      - `lookupLabel` string
      - `name` string: Word or phrase that constitutes the distinctive designation of a being or thing.
      - `ontologyIdentifier` string[]: Term or code used to identify something or someone registered within a particular ontology.
      - `relationAssessment` union
        - RelationAssessmentItem
          - `@context` VocabModel
            - `@vocab` string, required
          - `criteria` unknown
          - `inRelationTo` unknown, required
          - `qualitativeOverlap` unknown, required
        - RelationAssessmentItem1
          - `@context` VocabModel
            - `@vocab` string, required
          - `criteria` unknown
          - `inRelationTo` unknown, required
          - `quantitativeOverlap` union, required
            - QuantitativeOverlapItem
              - …
            - QuantitativeOverlapItem1
              - …
      - `versionIdentifier` string, required: Term or code used to identify the version of something.
      - `versionInnovation` string: Documentation on what changed in comparison to a previously published form of something.
    - `assigned_structure` ParcellationEntityVersionModel, required: ParcellationEntityVersionModel
      - `@type` string, required
      - `@context` VocabModel
        - `@vocab` string, required
      - `@id` string, required: Metadata node identifier.
      - `hasAnnotation` HasAnnotation
        - `@context` VocabModel
          - `@vocab` string, required
        - `bestViewPoint` BestViewPoint
          - `@context` VocabModel
            - `@vocab` string, required
          - `coordinateSpace` unknown, required
          - `coordinates` ApiModelsOpenmindsSANDSV3AtlasParcellationEntityVersionCoordinates[], required: Structured information on a quantitative value.
            - `@context` VocabModel
              - …
            - `typeOfUncertainty` unknown
            - `uncertainty` number[]: Quantitative value range defining the uncertainty of a measurement.
            - `unit` unknown
            - `value` number, required: Entry for a property.
        - `criteria` unknown
        - `criteriaQualityType` unknown, required
        - `displayColor` string: Preferred coloring.
        - `inspiredBy` unknown[]: Reference to an inspiring element.
          - unknown
        - `internalIdentifier` string, required: Term or code that identifies someone or something within a particular product.
        - `laterality` unknown[]: Differentiation between a pair of lateral homologous parts of the body.
          - unknown
        - `visualizedIn` unknown
      - `hasParent` unknown[]: Reference to a parent object or legal person.
        - unknown
      - `lookupLabel` string
      - `name` string: Word or phrase that constitutes the distinctive designation of a being or thing.
      - `ontologyIdentifier` string[]: Term or code used to identify something or someone registered within a particular ontology.
      - `relationAssessment` union
        - RelationAssessmentItem
          - `@context` VocabModel
            - `@vocab` string, required
          - `criteria` unknown
          - `inRelationTo` unknown, required
          - `qualitativeOverlap` unknown, required
        - RelationAssessmentItem1
          - `@context` VocabModel
            - `@vocab` string, required
          - `criteria` unknown
          - `inRelationTo` unknown, required
          - `quantitativeOverlap` union, required
            - QuantitativeOverlapItem
              - …
            - QuantitativeOverlapItem1
              - …
      - `versionIdentifier` string, required: Term or code used to identify the version of something.
      - `versionInnovation` string: Documentation on what changed in comparison to a previously published form of something.
    - `assigned_structure_parcellation` SiibraParcellationModel, required: SiibraParcellationModel
      - `@type` string, required
      - `@id` string, required
      - `name` string, required
      - `modality` string
      - `datasets` EbrainsDatasetModel[], required
        - `@type` string, required
        - `@id` string, required
        - `name` string, required
        - `urls` EbrainsDsUrl[], required
          - `@type` string, required
          - `url` string, required
        - `description` string
        - `contributors` EbrainsDsPerson[], required
          - `@type` string, required
          - `@id` string, required
          - `schema.org/shortName` string, required
          - `identifier` string, required
          - `shortName` string, required
          - `name` string, required
        - `ebrains_page` string
        - `custodians` EbrainsDsPerson[], required
          - `@type` string, required
          - `@id` string, required
          - `schema.org/shortName` string, required
          - `identifier` string, required
          - `shortName` string, required
          - `name` string, required
      - `brainAtlasVersions` BrainAtlasVersionModel[], required
        - `@type` string, required
        - `@context` VocabModel
          - `@vocab` string, required
        - `@id` string, required: Metadata node identifier.
        - `abbreviation` string
        - `accessibility` object, required: Level to which something is accessible to someone or something.
        - `atlasType` object
        - `author` unknown[]: Creator of a literary or creative work, as well as a dataset publication.
          - unknown
        - `coordinateSpace` object, required: Two or three dimensional geometric setting.
        - `copyright` Copyright
          - `@context` VocabModel
            - `@vocab` string, required
          - `holder` unknown[], required: Legal person in possession of something.
            - unknown
          - `year` string, required: Cycle in the Gregorian calendar specified by a number and comprised of 365 or 366 days divided into 12 months beginning with January and ending with December.
        - `custodian` unknown[]: The 'custodian' is a legal person who is responsible for the content and quality of the data, metadata, and/or code of a research product.
          - unknown
        - `description` string: Longer statement or account giving the characteristics of someone or something.
        - `digitalIdentifier` object: Digital handle to identify objects or legal persons.
        - `fullDocumentation` object, required: Non-abridged instructions, comments, and information for using a particular product.
        - `fullName` string: Whole, non-abbreviated name of something or somebody.
        - `funding` unknown[]: Money provided by a legal person for a particular purpose.
          - unknown
        - `hasTerminologyVersion` HasTerminologyVersion, required
          - `@context` VocabModel
            - `@vocab` string, required
          - `definedIn` unknown[]: Reference to a file instance in which something is stored.
            - unknown
          - `hasEntityVersion` unknown[], required
            - unknown
          - `ontologyIdentifier` string[]: Term or code used to identify something or someone registered within a particular ontology.
        - `homepage` object: Main website of something or someone.
        - `howToCite` string: Preferred format for citing a particular object or legal person.
        - `isAlternativeVersionOf` unknown[]: Reference to an original form where the essence was preserved, but presented in an alternative form.
          - unknown
        - `isNewVersionOf` object: Reference to a previous (potentially outdated) particular form of something.
        - `keyword` unknown[]: Significant word or concept that are representative of something or someone.
          - unknown
        - `license` object, required: Grant by a party to another party as an element of an agreement between those parties that permits to do, use, or own something.
        - `ontologyIdentifier` string[]: Term or code used to identify something or someone registered within a particular ontology.
        - `otherContribution` OtherContribution
          - `@context` VocabModel
            - `@vocab` string, required
          - `contributionType` unknown[], required: Distinct class of what was given or supplied as a part or share.
            - unknown
          - `contributor` unknown, required
        - `relatedPublication` unknown[]: Reference to something that was made available for the general public to see or buy.
          - unknown
        - `releaseDate` string, required: Fixed date on which a product is due to become or was made available for the general public to see or buy
        - `repository` object: Place, room, or container where something is deposited or stored.
        - `shortName` string, required: Shortened or fully abbreviated name of something or somebody.
        - `supportChannel` string[]: Way of communication used to interact with users or customers.
        - `versionIdentifier` string, required: Term or code used to identify the version of something.
        - `versionInnovation` string, required: Documentation on what changed in comparison to a previously published form of something.
      - `version` SiibraParcellationVersionModel: SiibraParcellationVersionModel
        - `@type` string, required
        - `name` string, required
        - `deprecated` boolean
        - `collection` string
        - `prev` SiibraAtIdModel
          - `@id` string, required
        - `next` SiibraAtIdModel
          - `@id` string, required
      - `shortname` string
  - `total` integer
  - `page` integer
  - `size` integer
  - `pages` integer

## Other responses

- `422`: Validation Error

## Changes

- **2026-07-17** `5adffd5f8b23`: 1 info
  - added the optional property `items/items/assigned_structure_parcellation/version/collection` to the response with the `200` status
- **2024-07-08** `0364172305cb`: 1 breaking
  - the response property `total` became optional for the status `200`
- **2024-01-15** `000d11ff581a`: 1 info
  - the response property `total` became required for the status `200`
- **2023-12-15** `4079a1b2e4b6`: 1 warning
  - removed the optional property `items/items/assigned_structure_parcellation/version/collection` from the response with the `200` status

[Operation history](https://skmtc.dev/fzj-inm1-bda/apis/siibra-api/changes/regions/:region_id/related/get.md)

---

[API](https://skmtc.dev/fzj-inm1-bda/apis/siibra-api.md) - [All operations](https://skmtc.dev/fzj-inm1-bda/apis/siibra-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fzj-inm1-bda/apis/siibra-api/revisions/5adffd5f8b23?raw)