CINXE.COM
ROR Data Structure
<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="ror"><meta name="readme-version" content="1"><title>ROR Data Structure</title><meta name="description" content="This document outlines the policies and definitions for top-level metadata elements in the ROR schema, including required fields such as organization ID, name, type, establishment year, relationships, addresses, status, and external identifiers."><meta property="og:title" content="ROR Data Structure"><meta property="og:description" content="This document outlines the policies and definitions for top-level metadata elements in the ROR schema, including required fields such as organization ID, name, type, establishment year, relationships, addresses, status, and external identifiers."><meta property="og:site_name" content="ROR"><meta name="twitter:title" content="ROR Data Structure"><meta name="twitter:description" content="This document outlines the policies and definitions for top-level metadata elements in the ROR schema, including required fields such as organization ID, name, type, establishment year, relationships, addresses, status, and external identifiers."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/4330c08-small-ror-logo-large.png"><meta name="twitter:image" content="https://files.readme.io/4330c08-small-ror-logo-large.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/a931430-small-ror-icon-profile_2.png" type="image/png"><link rel="canonical" href="https://ror.readme.io/docs/data-structure"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.905756735b64839665ac.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.e465d3c8429ef097e6ed.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#44A28F;--project-color-inverse:#222;--recipe-button-color:#44A28F;--recipe-button-color-hover:#265a50;--recipe-button-color-active:#173630;--recipe-button-color-focus:rgba(68, 162, 143, 0.25);--recipe-button-color-disabled:#c9e9e2}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#44A28F;--project-color-inverse:#222}a{color:var(--color-link-primary,#44a28f)}a:hover{color:var(--color-link-primary-darken-5,#265a50)}a.text-muted:hover{color:var(--color-link-primary,#44a28f)}.btn.btn-primary{background-color:#44a28f}.btn.btn-primary:hover{background-color:#265a50}.theme-line #hub-landing-top h2{color:#44a28f}#hub-landing-top .btn:hover{color:#44a28f}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#44a28f}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#44a28f,#227866)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#44a28f}.theme-line header#hub-header #header-top .btn{background-color:#44a28f}header#hub-header #header-top #header-logo{width:63px;height:40px;margin-top:0;background-image:url(https://files.readme.io/4330c08-small-ror-logo-large.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#44a28f}#subheader-links a.active{color:#44a28f!important;box-shadow:inset 0 -2px 0 #44a28f}#subheader-links a:hover{color:#44a28f!important;box-shadow:inset 0 -2px 0 #44a28f;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#44a28f}section#hub-discuss .discussion a .discuss-body h4{color:#44a28f}section#hub-discuss .discussion a:hover .discuss-body h4{color:#265a50}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#44a28f}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#44a28f}#hub-search-results h3 em{color:#44a28f}.main_background,.tag-item{background:#44a28f!important}.main_background:hover{background:#265a50!important}.main_color{color:#44a28f!important}.border_bottom_main_color{border-bottom:2px solid #44a28f}.main_color_hover:hover{color:#44a28f!important}section#hub-discuss h1{color:#44a28f}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#44a28f;background-color:#44a28f}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#265a50;border-color:#265a50}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#44a28f;color:#44a28f}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#44a28f);border-color:var(--project-color-primary,#44a28f)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#265a50;border-color:#265a50}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#44a28f;fill:var(--project-color-primary,#44a28f)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#44a28f}.main-color-accent{border-bottom:3px solid #44a28f;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES *//*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="ror"><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#44A28F;--color-primary-inverse:#fff;--color-primary-alt:#227866;--color-primary-darken-10:#357e6f;--color-primary-darken-20:#265a50;--color-primary-alpha-25:rgba(68, 162, 143, 0.25);--color-link-primary:#44A28F;--color-link-primary-darken-5:#3c907f;--color-link-primary-darken-10:#357e6f;--color-link-primary-darken-20:#265a50;--color-link-primary-alpha-50:rgba(68, 162, 143, 0.5);--color-link-primary-alpha-25:rgba(68, 162, 143, 0.25);--color-link-background:rgba(68, 162, 143, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="https://ror.org" target="_self"><img alt="ROR" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/4330c08-small-ror-logo-large.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://github.com/ror-community/ror-roadmap/issues/new/choose" target="_self" to="https://github.com/ror-community/ror-roadmap/issues/new/choose">Report a bug or request a feature</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/cdn-cgi/l/email-protection#e2919792928d9096a2908d90cc8d9085" target="_self" to="mailto:support@ror.org">Contact support</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option selected="" data-url="#" value="1">v1</option><option data-url="/v2/docs" value="2">v2</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://github.com/ror-community/ror-roadmap/issues/new/choose" rel="noopener" target="_blank" to="https://github.com/ror-community/ror-roadmap/issues/new/choose">Report a bug or request a feature</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/cdn-cgi/l/email-protection#31424441415e434571435e431f5e4356" target="_self" to="mailto:support@ror.org">Contact support</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/docs/data-structure" target="_self" to="/login?redirect_uri=/docs/data-structure">Log In</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="https://ror.org" target="_self"><img alt="ROR" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/4330c08-small-ror-logo-large.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/docs/data-structure" target="_self" class="Button Button_slate_text Button_md Header-link2tXYTgXq85zW undefined NavItem_mdrYO3ChA2kYvP rm-Header-top-link rm-Header-top-link_login Button_primary">Log In</a></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span>v<!-- -->1</span><i class="icon icon-chevron-down"></i></button></div><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><i class="icon-changelog"></i><span>Changelog</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Data structure</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting Started with ROR</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/identifier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Identifier pattern</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/display"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Logos and display guidelines</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/integrations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">See who uses ROR</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/get-involved"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get involved</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/feedback-docs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Community feedback documents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/contact"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Contact us</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">ROR Metadata</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/updates"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Updates and curation</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/data-structure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data structure</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/fields"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Fields and sub-fields</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/relationships"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Relationships and hierarchies</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/schema-versions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Schema versions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/schema-v2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Schema 2.0</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">ROR REST API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/rest-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">About the ROR REST API</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-single"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Retrieve a single record</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-list"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Retrieve a list of records</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-filtering"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Filtering</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-paging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Paging</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-query"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Query parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-advanced-query"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced query parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-affiliation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Affiliation parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-versions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">API versions</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Tools & Services</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/data-dump"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data dump</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/web-search"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Web search</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/openrefine-reconciler"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">OpenRefine reconciler</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Collecting ROR IDs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/forms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create ROR-powered forms</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/matching"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Match organization names to ROR IDs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/mapping"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Map other organization IDs to ROR IDs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/grid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transition from GRID to ROR</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/funder-registry"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transition from Open Funder Registry to ROR</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Sending ROR IDs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/crossref"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to Crossref DOIs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/datacite"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to DataCite DOIs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/jats"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to JATS XML</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/orcid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to ORCID records</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=ror" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Data structure</h1></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/data-structure"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<blockquote class="callout callout_default" theme="1️⃣"><h2 class="callout-heading"><span class="callout-icon">1️⃣</span><p>ROR Schema v1</p></h2><p>This page documents ROR metadata schema v1. For documentation of ROR metadata schema v2, see <a href="https://ror.readme.io/v2/docs/data-structure" target="" title="">https://ror.readme.io/v2/docs/data-structure</a>. You can also read more about ROR <a href="/docs/schema-versions" target="" title="" class="doc-link" data-sidebar="schema-versions">schema versions</a> and a summary of what&#x27;s new in ROR <a href="/docs/schema-v2" target="" title="" class="doc-link" data-sidebar="schema-v2">Schema 2.0</a>.</p></blockquote> <p>Version 1 of ROR&#x27;s data structure (aka its &quot;metadata schema&quot; or &quot;JSON schema&quot;) is based on <a href="https://digitalscience.figshare.com/search?q=GRID&amp;itemTypes=3" target="" title="">Digital Science&#x27;s GRID</a>, which provided the original seed data for the registry. GRID retired its public releases as of 16 Sep 2021, and ROR began managing its data independently from GRID in March 2022. The full JSON schema used for generating and validating ROR records is available at <a href="https://github.com/ror-community/ror-schema" target="" title="">https://github.com/ror-community/ror-schema</a>. </p> <p>The current ROR metadata schema inherited from GRID in 2019 is now unofficially known as version 1.0. After two rounds of community feedback in 2022/2023, <a href="/docs/schema-v2" target="" title="" class="doc-link" data-sidebar="schema-v2">metadata schema version 2.0</a> was developed and launched in April 2024. Version 1 of the ROR schema will continue to be available in the data dump and API at least through April 2025. Read more about ROR&#x27;s plans for metadata <a href="/docs/schema-versions" target="" title="" class="doc-link" data-sidebar="schema-versions">schema versioning</a>.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="fields"></div><div class="heading-text"><div id="section-fields" class="heading-anchor_backwardsCompatibility"></div>Fields</div><a aria-label="Skip link to Fields" class="heading-anchor-icon fa fa-anchor" href="#fields"></a></h1> <p>Below are listed the top-level fields (or &quot;elements&quot;) in the ROR metadata schema along with their names, definitions, types, whether the field is required, and whether a value in the field is required. Queries to the ROR API will return all fields regardless of whether they have a value. JSON will include null values and empty arrays and objects if there is no value available for the given organization. </p> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>New status &amp; relationship type values</p></h2><p>Beginning 1 Dec 2022, ROR supports new values <em>inactive</em> and <em>withdrawn</em> in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">status</code> and <em>Predecessor</em> and <em>Successor</em> in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships.type</code>. Previously, all records had a status of <em>active</em> and relationships types were limited to <em>Parent</em>, <em>Child</em>, and <em>Related</em>. See updated field descriptions for <a href="#status" target="" title="">status</a> and <a href="#relationships" target="" title="">relationships</a> below and <a href="https://ror.readme.io/changelog/2022-12-01-organization-status-changes" target="" title="">2022-12-01 changelog post </a> for more details.</p></blockquote> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Field name</th><th style="text-align:left">Definition</th><th style="text-align:left">Type</th><th style="text-align:left">Required</th><th style="text-align:left">Value required</th><th style="text-align:left">Remarks</th></tr></thead><tbody><tr><td style="text-align:left">id</td><td style="text-align:left">Unique ROR ID for the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">name</td><td style="text-align:left">The primary name of the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">email_address</td><td style="text-align:left">A contact mail address for the organization</td><td style="text-align:left">String</td><td style="text-align:left">FALSE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Deprecated field - Not actively curating</td></tr><tr><td style="text-align:left">ip_addresses</td><td style="text-align:left">IP address(es) associated with the organization</td><td style="text-align:left">Array</td><td style="text-align:left">FALSE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Deprecated field - Not actively curating</td></tr><tr><td style="text-align:left">established</td><td style="text-align:left">Year the organization was established (CE)</td><td style="text-align:left">Number</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">types</td><td style="text-align:left">Organization type</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left">Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other</td></tr><tr><td style="text-align:left">relationships</td><td style="text-align:left">Related organizations in ROR</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Allowed relationship types: Parent, Child, Related, Predecessor, Successor</td></tr><tr><td style="text-align:left">addresses</td><td style="text-align:left">The organization&#x27;s location</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">links</td><td style="text-align:left">Official website of the organization</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">aliases</td><td style="text-align:left">Other names the organization is known by</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">acronyms</td><td style="text-align:left">Acronyms or initialisms for the organization name</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">status</td><td style="text-align:left">Whether the organization is active or not</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left">Allowed values: Active, Inactive, Withdrawn</td></tr><tr><td style="text-align:left">wikipedia_url</td><td style="text-align:left">Wikipedia link for the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">labels</td><td style="text-align:left">Name(s) for the organization in other language(s)</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">country</td><td style="text-align:left">Country where organization is located</td><td style="text-align:left">Object</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">external_ids</td><td style="text-align:left">Other identifiers for the organization</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS.</td></tr></tbody></table></div></div> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>All available fields and sub-fields</p></h2><p>See also the complete alphabetical list of <a href="/docs/fields" target="" title="" class="doc-link" data-sidebar="fields">All ROR fields and sub-fields</a> in v1 of the ROR metadata schema.</p></blockquote> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="definitions-and-policies"></div><div class="heading-text"><div id="section-definitions-and-policies" class="heading-anchor_backwardsCompatibility"></div>Definitions and policies</div><a aria-label="Skip link to Definitions and policies" class="heading-anchor-icon fa fa-anchor" href="#definitions-and-policies"></a></h1> <p>Policies and expanded definitions for top-level metadata elements. See also <a href="https://github.com/ror-community/ror-updates/wiki/ROR-Metadata-Policies" target="" title="">ROR Metadata Policies on GitHub</a>.</p> <p><em>* indicates a value is required</em></p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="id"></div><div class="heading-text"><div id="section-id" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">id*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#id"></a></h2> <p>The ROR ID for the organization, created and assigned by ROR. See <a href="/docs/identifier" target="" title="" class="doc-link" data-sidebar="identifier">ROR identifier pattern</a> for more information on how the ROR ID is generated and structured. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="name"></div><div class="heading-text"><div id="section-name" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#name"></a></h2> <p>The official name of the organization used for affiliation purposes (this may be different than the organization&#x27;s legal name).</p> <p>Only one name can be included in the primary name field. ROR metadata includes additional fields (<button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code>, <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">labels</code>, <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">acronyms</code>) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.</p> <p>The primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.</p> <p>ROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.</p> <p>The primary data source for the organization name and formatting thereof is the organization&#x27;s website.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="email_address"></div><div class="heading-text"><div id="section-email-address" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">email_address</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#email_address"></a></h2> <p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="ip_addresses"></div><div class="heading-text"><div id="section-ip-addresses" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ip_addresses</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#ip_addresses"></a></h2> <p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="established"></div><div class="heading-text"><div id="section-established" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">established</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#established"></a></h2> <p>The year the organization was established, written as four digits (YYYY).</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="types"></div><div class="heading-text"><div id="section-types" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">types*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#types"></a></h2> <p>The type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.</p> <p>Based on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.</p> <p>Allowed types:</p> <p><strong>Education</strong>: A university or similar institution involved in providing education and educating/employing researchers</p> <p><strong>Healthcare</strong>: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.</p> <p><strong>Company</strong>: A private for-profit corporate entity involved in conducting or sponsoring research.</p> <p><strong>Archive</strong>: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.</p> <p><strong>Nonprofit</strong>: A non-profit and non-governmental organization involved in conducting or funding research.</p> <p><strong>Government</strong>: An organization that is part of or operated by a national or regional government and that conducts or supports research.</p> <p><strong>Facility</strong>: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.</p> <p><strong>Other</strong>: Use this category for any organization that does not fit the categories above.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="relationships"></div><div class="heading-text"><div id="section-relationships" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#relationships"></a></h2> <p>One or more organizations that the organization is related to.</p> <p>Five types of relations are supported: <em>Parent</em>, <em>Child</em>, <em>Related</em>, <em>Predecessor</em> and <em>Successor</em>. An organization can have multiple relationships but each relationship must be classified as Parent, Child, Related, Predecessor or Successor.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="inverse-relationships"></div><div class="heading-text"><div id="section-inverse-relationships" class="heading-anchor_backwardsCompatibility"></div>Inverse relationships</div><a aria-label="Skip link to Inverse relationships" class="heading-anchor-icon fa fa-anchor" href="#inverse-relationships"></a></h3> <p><em>Parent</em>, <em>Child</em> and <em>Related</em> types must have corresponding relationships in the related record, except in the case of records with status <em>inactive</em> or <em>withdrawn</em>. For example, if Organization A&#x27;s record contains a relationship to Organization B with type <em>Parent</em> (and both records have status <em>active</em>), Organization B&#x27;s record must contain a corresponding relationship to Organization A with type <em>Child</em>.</p> <p><em>Predecessor</em> and <em>Successor</em> types may optionally contain corresponding relationships in the related records, but they are not required. For example, if Organization A becomes inactive and contains a relationship to Organization B with type <em>Successor</em>, Organization B may or may not contain a corresponding relationship to Organization A with type <em>Predecessor</em>.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="relationships-to-inactive-records"></div><div class="heading-text"><div id="section-relationships-to-inactive-records" class="heading-anchor_backwardsCompatibility"></div>Relationships to inactive records</div><a aria-label="Skip link to Relationships to inactive records" class="heading-anchor-icon fa fa-anchor" href="#relationships-to-inactive-records"></a></h3> <p>Records with status <em>active</em> cannot contain relationships to records with status <em>inactive</em> or <em>withdrawn</em>, except for relationships with type <em>Predecessor</em>.</p> <p>Records with status <em>inactive</em> or <em>withdrawn</em> may have relationships to records with status <em>active</em> for the sake of preserving the record data at the time the record status was changed to inactive or withdrawn. These are not considering current relationships and do not require corresponding relationships in related records.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="successor-organizations"></div><div class="heading-text"><div id="section-successor-organizations" class="heading-anchor_backwardsCompatibility"></div>Successor organizations</div><a aria-label="Skip link to Successor organizations" class="heading-anchor-icon fa fa-anchor" href="#successor-organizations"></a></h3> <p>Records with a status of <em>inactive</em> or <em>withdrawn</em> may have one or more successor organizations listed in their relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn from the registry. If an organization simply changes its name, it will not receive a <em>Successor</em>; the existing ROR record for the organization will simply be modified with the new name in the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name</code> field and the previous name in the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code> field. </p> <p>Depending on your use case, you may wish to update references to <em>inactive</em> ROR records in your database or application to the corresponding <em>Successor</em> organization(s).</p> <p>If you are depositing DOI records, the name &amp; ROR ID of the organization should in general be kept historically correct. In other words, if an organization publishes content under a certain name and ROR ID, the name and ROR ID should remain the same in DOI metadata even if the organization later becomes inactive or is merged into a Successor organization. Relationships in ROR records ensure that research can still be tracked despite organizational changes. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="addresses"></div><div class="heading-text"><div id="section-addresses" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">addresses*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#addresses"></a></h2> <p>Location details for the organization. Location data comes from <a href="https://www.geonames.org/" target="" title="">GeoNames</a>.</p> <p>A city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country. Note too the existence of the separate top-level <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">country</code> element, which contains the name of the organization&#x27;s country and its two-letter ISO country code.</p> <p>GeoNames data is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/" target="" title="">Creative Commons Attribution 4.0 license</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="links"></div><div class="heading-text"><div id="section-links" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">links</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#links"></a></h2> <p>The primary website of the organization. Only one URL should be associated with the record.</p> <p>In the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="aliases"></div><div class="heading-text"><div id="section-aliases" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#aliases"></a></h2> <p>Used for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical, but future iterations of the ROR schema may differentiate between the two.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="acronyms"></div><div class="heading-text"><div id="section-acronyms" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">acronyms</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#acronyms"></a></h2> <p>One or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="status"></div><div class="heading-text"><div id="section-status" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">status*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#status"></a></h2> <p>Indication of whether the organization is active or not, based on a controlled list of status values. Allowed status values:</p> <p><strong>active:</strong> An organization that is actively producing research outputs.</p> <p><strong>inactive:</strong> An organization that has ceased operation or producing research outputs.</p> <p><strong>withdrawn:</strong> A record that was created in error, such as a duplicate record, or a record that is not in scope for the registry.</p> <p>A record with a status of <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">inactive</code> or <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">withdrawn</code> may have one or more Successor organizations listed in its relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn. See <a href="#relationships" target="" title="">relationships</a> for more information.</p> <p><em>Note: Prior to 1 Dec 2022, all records had a status of active. Read more about this change in the <a href="https://ror.readme.io/changelog/2022-12-01-organization-status-changes" target="" title="">Dec 1 release notes</a></em> </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="wikipedia_url"></div><div class="heading-text"><div id="section-wikipedia-url" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">wikipedia_url</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#wikipedia_url"></a></h2> <p>A Wikipedia page for the organization. Only one URL should be associated with the record.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="labels"></div><div class="heading-text"><div id="section-labels" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">labels</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#labels"></a></h2> <p>Displays versions of the organization name in one or more languages other than that used in the primary <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name</code> field, with a corresponding language tag based on the two-letter <a href="https://www.loc.gov/standards/iso639-2/php/code_list.php" target="" title="">ISO-639</a> code.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="country"></div><div class="heading-text"><div id="section-country" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">country*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#country"></a></h2> <p>Includes the name and the two-letter <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="" title="">ISO-3166</a> country code for the organization&#x27;s primary country. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="external_ids"></div><div class="heading-text"><div id="section-external-ids" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">external_ids</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#external_ids"></a></h2> <p>Other identifiers for the organization (if available).</p> <p>ROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).</p> <p>There are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-record"></div><div class="heading-text"><div id="section-example-record" class="heading-anchor_backwardsCompatibility"></div>Example record</div><a aria-label="Skip link to Example record" class="heading-anchor-icon fa fa-anchor" href="#example-record"></a></h1> <p>See the JSON structure in an example organization record.</p> <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar" role="tablist"><button aria-selected="true" class="CodeTabs_active" role="tab" type="button">JSON</button></div><div class="CodeTabs-inner" role="tabpanel"><pre><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang-json theme-light" data-lang="json" name="" tabindex="0">{ &quot;id&quot;:&quot;https://ror.org/013cjyk83&quot;, &quot;name&quot;:&quot;PSL Research University&quot;, &quot;email_address&quot;:null, &quot;ip_addresses&quot;:[ ], &quot;established&quot;:2010, &quot;types&quot;:[ &quot;Education&quot; ], &quot;relationships&quot;:[ { &quot;label&quot;:&quot;ESPCI Paris&quot;, &quot;type&quot;:&quot;Child&quot;, &quot;id&quot;:&quot;https://ror.org/03zx86w41&quot; }, { &quot;label&quot;:&quot;Subcellular Structure and Cellular Dynamics&quot;, &quot;type&quot;:&quot;Child&quot;, &quot;id&quot;:&quot;https://ror.org/04w11tv37&quot; }, { &quot;label&quot;:&quot;École Pratique des Hautes Études&quot;, &quot;type&quot;:&quot;Child&quot;, &quot;id&quot;:&quot;https://ror.org/046b3cj80&quot; } ], &quot;addresses&quot;:[ { &quot;lat&quot;:48.854692, &quot;lng&quot;:2.33781, &quot;state&quot;:null, &quot;state_code&quot;:null, &quot;city&quot;:&quot;Paris&quot;, &quot;geonames_city&quot;:{ &quot;id&quot;:2988507, &quot;city&quot;:&quot;Paris&quot;, &quot;geonames_admin1&quot;:{ &quot;name&quot;:&quot;Île-de-France&quot;, &quot;id&quot;:3012874, &quot;ascii_name&quot;:&quot;Ile-de-France&quot;, &quot;code&quot;:&quot;FR.11&quot; }, &quot;geonames_admin2&quot;:{ &quot;name&quot;:&quot;Paris&quot;, &quot;id&quot;:2968815, &quot;ascii_name&quot;:&quot;Paris&quot;, &quot;code&quot;:&quot;FR.11.75&quot; }, &quot;license&quot;:{ &quot;attribution&quot;:&quot;Data from geonames.org under a CC-BY 3.0 license&quot;, &quot;license&quot;:&quot;http://creativecommons.org/licenses/by/3.0/&quot; }, &quot;nuts_level1&quot;:{ &quot;name&quot;:&quot;ÎLE DE FRANCE&quot;, &quot;code&quot;:&quot;FR1&quot; }, &quot;nuts_level2&quot;:{ &quot;name&quot;:&quot;Île de France&quot;, &quot;code&quot;:&quot;FR10&quot; }, &quot;nuts_level3&quot;:{ &quot;name&quot;:&quot;Paris&quot;, &quot;code&quot;:&quot;FR101&quot; } }, &quot;postcode&quot;:null, &quot;primary&quot;:false, &quot;line&quot;:null, &quot;country_geonames_id&quot;:3017382 } ], &quot;links&quot;:[ &quot;https://www.psl.eu/en/university&quot; ], &quot;aliases&quot;:[ &quot;Université PSL&quot; ], &quot;acronyms&quot;:[ &quot;PSL&quot; ], &quot;status&quot;:&quot;active&quot;, &quot;wikipedia_url&quot;:&quot;https://en.wikipedia.org/wiki/PSL_Research_University&quot;, &quot;labels&quot;:[ { &quot;label&quot;:&quot;Université de recherche Paris Sciences et Lettres&quot;, &quot;iso639&quot;:&quot;fr&quot; } ], &quot;country&quot;:{ &quot;country_name&quot;:&quot;France&quot;, &quot;country_code&quot;:&quot;FR&quot; }, &quot;external_ids&quot;:{ &quot;ISNI&quot;:{ &quot;preferred&quot;:null, &quot;all&quot;:[ &quot;0000 0004 1784 3645&quot; ] }, &quot;OrgRef&quot;:{ &quot;preferred&quot;:null, &quot;all&quot;:[ &quot;31274670&quot; ] }, &quot;Wikidata&quot;:{ &quot;preferred&quot;:null, &quot;all&quot;:[ &quot;Q1163431&quot; ] }, &quot;GRID&quot;:{ &quot;preferred&quot;:&quot;grid.440907.e&quot;, &quot;all&quot;:&quot;grid.440907.e&quot; } } } </code></pre></div></div>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><blockquote class="callout callout_default" theme="1️⃣"><h2 class="callout-heading"><span class="callout-icon">1️⃣</span><p>ROR Schema v1</p></h2><p>This page documents ROR metadata schema v1. For documentation of ROR metadata schema v2, see <a target="_self" href="/v2/docs/data-structure">https://ror.readme.io/v2/docs/data-structure</a>. You can also read more about ROR <a target="_self" href="/docs/schema-versions">schema versions</a> and a summary of what's new in ROR <a target="_self" href="/docs/schema-v2">Schema 2.0</a>.</p></blockquote> <p>Version 1 of ROR's data structure (aka its "metadata schema" or "JSON schema") is based on <a target="_self" href="https://digitalscience.figshare.com/search?q=GRID&itemTypes=3">Digital Science's GRID</a>, which provided the original seed data for the registry. GRID retired its public releases as of 16 Sep 2021, and ROR began managing its data independently from GRID in March 2022. The full JSON schema used for generating and validating ROR records is available at <a target="_self" href="https://github.com/ror-community/ror-schema">https://github.com/ror-community/ror-schema</a>. </p> <p>The current ROR metadata schema inherited from GRID in 2019 is now unofficially known as version 1.0. After two rounds of community feedback in 2022/2023, <a target="_self" href="/docs/schema-v2">metadata schema version 2.0</a> was developed and launched in April 2024. Version 1 of the ROR schema will continue to be available in the data dump and API at least through April 2025. Read more about ROR's plans for metadata <a target="_self" href="/docs/schema-versions">schema versioning</a>.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="fields"></div><div class="heading-text"><div id="section-fields" class="heading-anchor_backwardsCompatibility"></div>Fields</div><a aria-label="Skip link to Fields" class="heading-anchor-icon fa fa-anchor" href="#fields"></a></h1> <p>Below are listed the top-level fields (or "elements") in the ROR metadata schema along with their names, definitions, types, whether the field is required, and whether a value in the field is required. Queries to the ROR API will return all fields regardless of whether they have a value. JSON will include null values and empty arrays and objects if there is no value available for the given organization. </p> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>New status & relationship type values</p></h2><p>Beginning 1 Dec 2022, ROR supports new values <em>inactive</em> and <em>withdrawn</em> in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">status</code> and <em>Predecessor</em> and <em>Successor</em> in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships.type</code>. Previously, all records had a status of <em>active</em> and relationships types were limited to <em>Parent</em>, <em>Child</em>, and <em>Related</em>. See updated field descriptions for <a target="_self" href="#status">status</a> and <a target="_self" href="#relationships">relationships</a> below and <a target="_self" href="/changelog/2022-12-01-organization-status-changes">2022-12-01 changelog post </a> for more details.</p></blockquote> <div class="rdmd-table"><div class="rdmd-table-inner"><table><thead><tr><th style="text-align:left">Field name</th><th style="text-align:left">Definition</th><th style="text-align:left">Type</th><th style="text-align:left">Required</th><th style="text-align:left">Value required</th><th style="text-align:left">Remarks</th></tr></thead><tbody><tr><td style="text-align:left">id</td><td style="text-align:left">Unique ROR ID for the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">name</td><td style="text-align:left">The primary name of the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">email_address</td><td style="text-align:left">A contact mail address for the organization</td><td style="text-align:left">String</td><td style="text-align:left">FALSE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Deprecated field - Not actively curating</td></tr><tr><td style="text-align:left">ip_addresses</td><td style="text-align:left">IP address(es) associated with the organization</td><td style="text-align:left">Array</td><td style="text-align:left">FALSE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Deprecated field - Not actively curating</td></tr><tr><td style="text-align:left">established</td><td style="text-align:left">Year the organization was established (CE)</td><td style="text-align:left">Number</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">types</td><td style="text-align:left">Organization type</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left">Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other</td></tr><tr><td style="text-align:left">relationships</td><td style="text-align:left">Related organizations in ROR</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Allowed relationship types: Parent, Child, Related, Predecessor, Successor</td></tr><tr><td style="text-align:left">addresses</td><td style="text-align:left">The organization's location</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">links</td><td style="text-align:left">Official website of the organization</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">aliases</td><td style="text-align:left">Other names the organization is known by</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">acronyms</td><td style="text-align:left">Acronyms or initialisms for the organization name</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">status</td><td style="text-align:left">Whether the organization is active or not</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left">Allowed values: Active, Inactive, Withdrawn</td></tr><tr><td style="text-align:left">wikipedia_url</td><td style="text-align:left">Wikipedia link for the organization</td><td style="text-align:left">String</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">labels</td><td style="text-align:left">Name(s) for the organization in other language(s)</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">country</td><td style="text-align:left">Country where organization is located</td><td style="text-align:left">Object</td><td style="text-align:left">TRUE</td><td style="text-align:left">TRUE</td><td style="text-align:left"></td></tr><tr><td style="text-align:left">external_ids</td><td style="text-align:left">Other identifiers for the organization</td><td style="text-align:left">Array</td><td style="text-align:left">TRUE</td><td style="text-align:left">FALSE</td><td style="text-align:left">Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS.</td></tr></tbody></table></div></div> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>All available fields and sub-fields</p></h2><p>See also the complete alphabetical list of <a target="_self" href="/docs/fields">All ROR fields and sub-fields</a> in v1 of the ROR metadata schema.</p></blockquote> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="definitions-and-policies"></div><div class="heading-text"><div id="section-definitions-and-policies" class="heading-anchor_backwardsCompatibility"></div>Definitions and policies</div><a aria-label="Skip link to Definitions and policies" class="heading-anchor-icon fa fa-anchor" href="#definitions-and-policies"></a></h1> <p>Policies and expanded definitions for top-level metadata elements. See also <a target="_self" href="https://github.com/ror-community/ror-updates/wiki/ROR-Metadata-Policies">ROR Metadata Policies on GitHub</a>.</p> <p><em>* indicates a value is required</em></p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="id"></div><div class="heading-text"><div id="section-id" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">id*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#id"></a></h2> <p>The ROR ID for the organization, created and assigned by ROR. See <a target="_self" href="/docs/identifier">ROR identifier pattern</a> for more information on how the ROR ID is generated and structured. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="name"></div><div class="heading-text"><div id="section-name" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#name"></a></h2> <p>The official name of the organization used for affiliation purposes (this may be different than the organization's legal name).</p> <p>Only one name can be included in the primary name field. ROR metadata includes additional fields (<button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code>, <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">labels</code>, <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">acronyms</code>) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.</p> <p>The primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.</p> <p>ROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.</p> <p>The primary data source for the organization name and formatting thereof is the organization's website.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="email_address"></div><div class="heading-text"><div id="section-email-address" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">email_address</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#email_address"></a></h2> <p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="ip_addresses"></div><div class="heading-text"><div id="section-ip-addresses" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">ip_addresses</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#ip_addresses"></a></h2> <p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="established"></div><div class="heading-text"><div id="section-established" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">established</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#established"></a></h2> <p>The year the organization was established, written as four digits (YYYY).</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="types"></div><div class="heading-text"><div id="section-types" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">types*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#types"></a></h2> <p>The type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.</p> <p>Based on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.</p> <p>Allowed types:</p> <p><strong>Education</strong>: A university or similar institution involved in providing education and educating/employing researchers</p> <p><strong>Healthcare</strong>: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.</p> <p><strong>Company</strong>: A private for-profit corporate entity involved in conducting or sponsoring research.</p> <p><strong>Archive</strong>: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.</p> <p><strong>Nonprofit</strong>: A non-profit and non-governmental organization involved in conducting or funding research.</p> <p><strong>Government</strong>: An organization that is part of or operated by a national or regional government and that conducts or supports research.</p> <p><strong>Facility</strong>: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.</p> <p><strong>Other</strong>: Use this category for any organization that does not fit the categories above.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="relationships"></div><div class="heading-text"><div id="section-relationships" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#relationships"></a></h2> <p>One or more organizations that the organization is related to.</p> <p>Five types of relations are supported: <em>Parent</em>, <em>Child</em>, <em>Related</em>, <em>Predecessor</em> and <em>Successor</em>. An organization can have multiple relationships but each relationship must be classified as Parent, Child, Related, Predecessor or Successor.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="inverse-relationships"></div><div class="heading-text"><div id="section-inverse-relationships" class="heading-anchor_backwardsCompatibility"></div>Inverse relationships</div><a aria-label="Skip link to Inverse relationships" class="heading-anchor-icon fa fa-anchor" href="#inverse-relationships"></a></h3> <p><em>Parent</em>, <em>Child</em> and <em>Related</em> types must have corresponding relationships in the related record, except in the case of records with status <em>inactive</em> or <em>withdrawn</em>. For example, if Organization A's record contains a relationship to Organization B with type <em>Parent</em> (and both records have status <em>active</em>), Organization B's record must contain a corresponding relationship to Organization A with type <em>Child</em>.</p> <p><em>Predecessor</em> and <em>Successor</em> types may optionally contain corresponding relationships in the related records, but they are not required. For example, if Organization A becomes inactive and contains a relationship to Organization B with type <em>Successor</em>, Organization B may or may not contain a corresponding relationship to Organization A with type <em>Predecessor</em>.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="relationships-to-inactive-records"></div><div class="heading-text"><div id="section-relationships-to-inactive-records" class="heading-anchor_backwardsCompatibility"></div>Relationships to inactive records</div><a aria-label="Skip link to Relationships to inactive records" class="heading-anchor-icon fa fa-anchor" href="#relationships-to-inactive-records"></a></h3> <p>Records with status <em>active</em> cannot contain relationships to records with status <em>inactive</em> or <em>withdrawn</em>, except for relationships with type <em>Predecessor</em>.</p> <p>Records with status <em>inactive</em> or <em>withdrawn</em> may have relationships to records with status <em>active</em> for the sake of preserving the record data at the time the record status was changed to inactive or withdrawn. These are not considering current relationships and do not require corresponding relationships in related records.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="successor-organizations"></div><div class="heading-text"><div id="section-successor-organizations" class="heading-anchor_backwardsCompatibility"></div>Successor organizations</div><a aria-label="Skip link to Successor organizations" class="heading-anchor-icon fa fa-anchor" href="#successor-organizations"></a></h3> <p>Records with a status of <em>inactive</em> or <em>withdrawn</em> may have one or more successor organizations listed in their relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn from the registry. If an organization simply changes its name, it will not receive a <em>Successor</em>; the existing ROR record for the organization will simply be modified with the new name in the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name</code> field and the previous name in the <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code> field. </p> <p>Depending on your use case, you may wish to update references to <em>inactive</em> ROR records in your database or application to the corresponding <em>Successor</em> organization(s).</p> <p>If you are depositing DOI records, the name & ROR ID of the organization should in general be kept historically correct. In other words, if an organization publishes content under a certain name and ROR ID, the name and ROR ID should remain the same in DOI metadata even if the organization later becomes inactive or is merged into a Successor organization. Relationships in ROR records ensure that research can still be tracked despite organizational changes. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="addresses"></div><div class="heading-text"><div id="section-addresses" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">addresses*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#addresses"></a></h2> <p>Location details for the organization. Location data comes from <a target="_self" href="https://www.geonames.org/">GeoNames</a>.</p> <p>A city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country. Note too the existence of the separate top-level <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">country</code> element, which contains the name of the organization's country and its two-letter ISO country code.</p> <p>GeoNames data is licensed under a <a target="_self" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 license</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="links"></div><div class="heading-text"><div id="section-links" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">links</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#links"></a></h2> <p>The primary website of the organization. Only one URL should be associated with the record.</p> <p>In the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="aliases"></div><div class="heading-text"><div id="section-aliases" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">aliases</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#aliases"></a></h2> <p>Used for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical, but future iterations of the ROR schema may differentiate between the two.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="acronyms"></div><div class="heading-text"><div id="section-acronyms" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">acronyms</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#acronyms"></a></h2> <p>One or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="status"></div><div class="heading-text"><div id="section-status" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">status*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#status"></a></h2> <p>Indication of whether the organization is active or not, based on a controlled list of status values. Allowed status values:</p> <p><strong>active:</strong> An organization that is actively producing research outputs.</p> <p><strong>inactive:</strong> An organization that has ceased operation or producing research outputs.</p> <p><strong>withdrawn:</strong> A record that was created in error, such as a duplicate record, or a record that is not in scope for the registry.</p> <p>A record with a status of <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">inactive</code> or <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">withdrawn</code> may have one or more Successor organizations listed in its relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn. See <a target="_self" href="#relationships">relationships</a> for more information.</p> <p><em>Note: Prior to 1 Dec 2022, all records had a status of active. Read more about this change in the <a target="_self" href="/changelog/2022-12-01-organization-status-changes">Dec 1 release notes</a></em> </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="wikipedia_url"></div><div class="heading-text"><div id="section-wikipedia-url" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">wikipedia_url</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#wikipedia_url"></a></h2> <p>A Wikipedia page for the organization. Only one URL should be associated with the record.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="labels"></div><div class="heading-text"><div id="section-labels" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">labels</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#labels"></a></h2> <p>Displays versions of the organization name in one or more languages other than that used in the primary <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">name</code> field, with a corresponding language tag based on the two-letter <a target="_self" href="https://www.loc.gov/standards/iso639-2/php/code_list.php">ISO-639</a> code.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="country"></div><div class="heading-text"><div id="section-country" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">country*</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#country"></a></h2> <p>Includes the name and the two-letter <a target="_self" href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO-3166</a> country code for the organization's primary country. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="external_ids"></div><div class="heading-text"><div id="section-external-ids" class="heading-anchor_backwardsCompatibility"></div><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">external_ids</code></div><a aria-label="Skip link to [object Object]" class="heading-anchor-icon fa fa-anchor" href="#external_ids"></a></h2> <p>Other identifiers for the organization (if available).</p> <p>ROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).</p> <p>There are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-record"></div><div class="heading-text"><div id="section-example-record" class="heading-anchor_backwardsCompatibility"></div>Example record</div><a aria-label="Skip link to Example record" class="heading-anchor-icon fa fa-anchor" href="#example-record"></a></h1> <p>See the JSON structure in an example organization record.</p> <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar" role="tablist"><button aria-selected="true" class="CodeTabs_active" role="tab" type="button">JSON</button></div><div class="CodeTabs-inner" role="tabpanel"><pre><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang-json theme-light" data-lang="json" name="" tabindex="0">{ "id":"https://ror.org/013cjyk83", "name":"PSL Research University", "email_address":null, "ip_addresses":[ ], "established":2010, "types":[ "Education" ], "relationships":[ { "label":"ESPCI Paris", "type":"Child", "id":"https://ror.org/03zx86w41" }, { "label":"Subcellular Structure and Cellular Dynamics", "type":"Child", "id":"https://ror.org/04w11tv37" }, { "label":"École Pratique des Hautes Études", "type":"Child", "id":"https://ror.org/046b3cj80" } ], "addresses":[ { "lat":48.854692, "lng":2.33781, "state":null, "state_code":null, "city":"Paris", "geonames_city":{ "id":2988507, "city":"Paris", "geonames_admin1":{ "name":"Île-de-France", "id":3012874, "ascii_name":"Ile-de-France", "code":"FR.11" }, "geonames_admin2":{ "name":"Paris", "id":2968815, "ascii_name":"Paris", "code":"FR.11.75" }, "license":{ "attribution":"Data from geonames.org under a CC-BY 3.0 license", "license":"http://creativecommons.org/licenses/by/3.0/" }, "nuts_level1":{ "name":"ÎLE DE FRANCE", "code":"FR1" }, "nuts_level2":{ "name":"Île de France", "code":"FR10" }, "nuts_level3":{ "name":"Paris", "code":"FR101" } }, "postcode":null, "primary":false, "line":null, "country_geonames_id":3017382 } ], "links":[ "https://www.psl.eu/en/university" ], "aliases":[ "Université PSL" ], "acronyms":[ "PSL" ], "status":"active", "wikipedia_url":"https://en.wikipedia.org/wiki/PSL_Research_University", "labels":[ { "label":"Université de recherche Paris Sciences et Lettres", "iso639":"fr" } ], "country":{ "country_name":"France", "country_code":"FR" }, "external_ids":{ "ISNI":{ "preferred":null, "all":[ "0000 0004 1784 3645" ] }, "OrgRef":{ "preferred":null, "all":[ "31274670" ] }, "Wikidata":{ "preferred":null, "all":[ "Q1163431" ] }, "GRID":{ "preferred":"grid.440907.e", "all":"grid.440907.e" } } } </code></pre></div></div></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated<!-- --> <!-- -->16 days ago<!-- --> </p></div><hr class="NextStepsDivider"/><nav aria-label="Pagination Controls" class="PaginationControlsjDYuqu8pBMUy rm-Pagination"></nav></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li> <a href="#fields">Fields</a> </li> <li> <a href="#definitions-and-policies">Definitions and policies</a> <ul> <li><a href="#id"><code>id*</code></a></li> <li><a href="#name"><code>name*</code></a></li> <li><a href="#email_address"><code>email_address</code></a></li> <li><a href="#ip_addresses"><code>ip_addresses</code></a></li> <li><a href="#established"><code>established</code></a></li> <li><a href="#types"><code>types*</code></a></li> <li><a href="#relationships"><code>relationships</code></a></li> <li><a href="#addresses"><code>addresses*</code></a></li> <li><a href="#links"><code>links</code></a></li> <li><a href="#aliases"><code>aliases</code></a></li> <li><a href="#acronyms"><code>acronyms</code></a></li> <li><a href="#status"><code>status*</code></a></li> <li><a href="#wikipedia_url"><code>wikipedia_url</code></a></li> <li><a href="#labels"><code>labels</code></a></li> <li><a href="#country"><code>country*</code></a></li> <li><a href="#external_ids"><code>external_ids</code></a></li> </ul> </li> <li> <a href="#example-record">Example record</a> </li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"60d25b23765a5900437c8fce","title":"Getting Started with ROR","slug":"getting-started","order":1,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:50:27.898Z","__v":0,"pages":[{"_id":"62fb961f8d112700211bbf15","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Identifier pattern","icon":"","type":"basic","slug":"identifier","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-identifier-pattern","createdAt":"2022-08-16T13:05:35.053Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"630d0205f1b18c003de1d215","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Logos and display guidelines","icon":"","type":"basic","slug":"display","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-id-display-guidelines-and-logos","createdAt":"2022-08-29T18:14:29.139Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"60f8832f8d0c540065cf57a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"See who uses ROR","type":"basic","slug":"integrations","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-integrations","createdAt":"2021-07-21T20:27:27.858Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60f88138b824e4001ccd7e71","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get involved","type":"basic","slug":"get-involved","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-07-21T20:19:04.850Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6466838e94b6bb00501efe6a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Community feedback documents","icon":"","type":"basic","slug":"feedback-docs","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"community-feedback-documents","category":"60d25b23765a5900437c8fce","createdAt":"2023-05-18T19:59:10.204Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"60d5e6e464e12b0055eda723","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Contact us","type":"basic","slug":"contact","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-in-touch","createdAt":"2021-06-25T14:23:32.577Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"65ec6c03aff86d0072a566d7","title":"ROR Metadata","slug":"ror-metadata","order":3,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2024-03-09T14:02:43.834Z","__v":0,"pages":[{"_id":"60d25d9079d8a0002a2a0da0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Updates and curation","type":"basic","slug":"updates","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-ror-is-updated","createdAt":"2021-06-22T22:00:48.485Z","category":"65ec6c03aff86d0072a566d7","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60d25da0b85dae005598be27","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Data structure","type":"basic","slug":"data-structure","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-data-structure","createdAt":"2021-06-22T22:01:04.607Z","category":"65ec6c03aff86d0072a566d7","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6441a31ed32dc616a0b51f7b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Fields and sub-fields","icon":"","type":"basic","slug":"fields","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"all-ror-fields-and-sub-fields","category":"65ec6c03aff86d0072a566d7","createdAt":"2023-04-20T20:39:58.302Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63ea71505bccd0025b40056a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Relationships and hierarchies","icon":"","type":"basic","slug":"relationships","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-hierarchies-and-relationships","category":"65ec6c03aff86d0072a566d7","createdAt":"2023-02-13T17:20:16.915Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6441b9979730ea1a3d0b0afb","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Schema versions","icon":"","type":"basic","slug":"schema-versions","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"api-versioning-copy","parentDoc":null,"category":"65ec6c03aff86d0072a566d7","createdAt":"2023-04-20T22:15:51.461Z","isBodyEmpty":false,"children":[]},{"_id":"6464d64fef9bab0066e99315","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Schema 2.0","icon":"","type":"basic","slug":"schema-v2","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-v20","parentDoc":null,"category":"65ec6c03aff86d0072a566d7","createdAt":"2023-05-17T13:27:43.797Z","isBodyEmpty":false,"children":[]}]},{"_id":"653c1e6f1cd9f1004b55cc72","title":"ROR REST API","slug":"rest-api","order":5,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2023-10-27T20:32:47.999Z","__v":0,"pages":[{"_id":"63fc803674ca3e0045af2ddb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"About the ROR REST API","icon":"","type":"basic","slug":"rest-api","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"api-about","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-02-27T10:04:38.511Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6465068f99bbc20028cc7084","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Retrieve a single record","icon":"","type":"basic","slug":"api-single","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-single-ror-record","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T16:53:35.628Z","isBodyEmpty":false,"children":[]},{"_id":"6465071071aace1d6f61fd7e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Retrieve a list of records","icon":"","type":"basic","slug":"api-list","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-list-of-ror-records","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T16:55:44.021Z","isBodyEmpty":false,"children":[]},{"_id":"646564ed6206730045608ea7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Filtering","icon":"","type":"basic","slug":"api-filtering","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"filtering","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T23:36:13.204Z","isBodyEmpty":false,"children":[]},{"_id":"646564bf25682100246d7641","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Paging","icon":"","type":"basic","slug":"api-paging","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"paging","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T23:35:27.796Z","isBodyEmpty":false,"children":[]},{"_id":"63d1a47566e590002a7fc9d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Query parameter","icon":"","type":"basic","slug":"api-query","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"query-parameter","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-01-25T21:51:49.092Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"641211ffd09495007a04c5b0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Advanced query parameter","icon":"","type":"basic","slug":"api-advanced-query","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"advanced-query-parameter","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-03-15T18:44:15.278Z","isBodyEmpty":false,"children":[]},{"_id":"63d1a4b9149169004c68b881","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Affiliation parameter","icon":"","type":"basic","slug":"api-affiliation","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"affiliation-parameter","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-01-25T21:52:57.629Z","isBodyEmpty":false,"children":[]},{"_id":"6441a7b0de10cd149041710c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"API versions","icon":"","type":"basic","slug":"api-versions","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-and-api-versioning-1","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-04-20T20:59:28.209Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"60d25b780dfce1003f4547aa","title":"Tools & Services","slug":"tools-services","order":6,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:51:52.183Z","__v":0,"pages":[{"_id":"60d3d01ac6b0030070645391","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Data dump","type":"basic","slug":"data-dump","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-24T00:21:46.090Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60fee88bae1bb3000f317da2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Web search","type":"basic","slug":"web-search","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"web-search-interface","createdAt":"2021-07-26T16:53:31.701Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60d3d0249841a7004a372925","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OpenRefine reconciler","type":"basic","slug":"openrefine-reconciler","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-24T00:21:56.714Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"64426d364b8f4c00604bb504","title":"Collecting ROR IDs","slug":"mapping-and-matching","order":7,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2023-04-21T11:02:14.913Z","__v":0,"pages":[{"_id":"6388f77b6c803f0024576f3d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create ROR-powered forms","icon":"","type":"basic","slug":"forms","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-ror-powered-typeaheads","createdAt":"2022-12-01T18:50:35.957Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"60d3e4c27dccd0004443bc84","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Match organization names to ROR IDs","type":"basic","slug":"matching","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"match-organization-names-to-ror-ids","createdAt":"2021-06-24T01:49:54.894Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60d3e492c16abe006427745b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Map other organization IDs to ROR IDs","type":"basic","slug":"mapping","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"map-other-organization-id-types-to-ror","createdAt":"2021-06-24T01:49:06.244Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60f0d77625052e007e5fdeea","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Transition from GRID to ROR","type":"basic","slug":"grid","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"gridror-transition-faq","createdAt":"2021-07-16T00:48:54.225Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"65e8e50442039e001d1bf878","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Transition from Open Funder Registry to ROR","icon":"","type":"basic","slug":"funder-registry","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"open-funder-registry-ror-transition-faq","category":"64426d364b8f4c00604bb504","createdAt":"2024-03-06T21:49:56.732Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"60d25b63bd8660001006bcba","title":"Sending ROR IDs","slug":"implementation-how-to-guides","order":8,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:51:31.872Z","__v":0,"pages":[{"_id":"6441b9fc874e64005e3748cb","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Add ROR IDs to Crossref DOIs","icon":"","type":"basic","slug":"crossref","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-crossref-dois","category":"60d25b63bd8660001006bcba","createdAt":"2023-04-20T22:17:32.825Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6441ba1deda7550012b9c1df","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Add ROR IDs to DataCite DOIs","icon":"","type":"basic","slug":"datacite","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-datacite-dois","category":"60d25b63bd8660001006bcba","createdAt":"2023-04-20T22:18:05.994Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6320a168f8e794131108ae63","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Add ROR IDs to JATS XML","icon":"","type":"basic","slug":"jats","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-jats-xml","createdAt":"2022-09-13T15:27:36.976Z","category":"60d25b63bd8660001006bcba","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6182d13df84631005aa3c8e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Add ROR IDs to ORCID records","type":"basic","slug":"orcid","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-orcid-record-data","createdAt":"2021-11-03T18:13:17.918Z","category":"60d25b63bd8660001006bcba","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]}],"refs":[]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"ODczNzdiMDdiZDc1ZWRiOGQyYWVlYzVjMTdiMjg3ZmEwNWUyZDk3YWJlMDc5ZTliNmFhNTE2ZWY3ZDhiOGUyZnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODM3KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"6058e47681775f002de04832","name":"ROR","subdomain":"ror","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"ror"},"version":"1"}},"activeDoc":"data-structure","rdmd":{"baseUrl":"/","body":"> 1️⃣ ROR Schema v1\n> \n> This page documents ROR metadata schema v1. For documentation of ROR metadata schema v2, see <https://ror.readme.io/v2/docs/data-structure>. You can also read more about ROR [schema versions](doc:schema-versions) and a summary of what's new in ROR [Schema 2.0](doc:schema-v2).\n\nVersion 1 of ROR's data structure (aka its \"metadata schema\" or \"JSON schema\") is based on [Digital Science's GRID](https://digitalscience.figshare.com/search?q=GRID&itemTypes=3), which provided the original seed data for the registry. GRID retired its public releases as of 16 Sep 2021, and ROR began managing its data independently from GRID in March 2022. The full JSON schema used for generating and validating ROR records is available at <https://github.com/ror-community/ror-schema>. \n\nThe current ROR metadata schema inherited from GRID in 2019 is now unofficially known as version 1.0. After two rounds of community feedback in 2022/2023, [metadata schema version 2.0](doc:schema-v2) was developed and launched in April 2024. Version 1 of the ROR schema will continue to be available in the data dump and API at least through April 2025. Read more about ROR's plans for metadata [schema versioning](doc:schema-versions).\n\n# Fields\n\nBelow are listed the top-level fields (or \"elements\") in the ROR metadata schema along with their names, definitions, types, whether the field is required, and whether a value in the field is required. Queries to the ROR API will return all fields regardless of whether they have a value. JSON will include null values and empty arrays and objects if there is no value available for the given organization. \n\n> 🚧 New status & relationship type values\n> \n> Beginning 1 Dec 2022, ROR supports new values _inactive_ and _withdrawn_ in `status` and _Predecessor_ and _Successor_ in `relationships.type`. Previously, all records had a status of _active_ and relationships types were limited to _Parent_, _Child_, and _Related_. See updated field descriptions for [status](#status) and [relationships](#relationships) below and [2022-12-01 changelog post ](https://ror.readme.io/changelog/2022-12-01-organization-status-changes) for more details.\n\n| Field name | Definition | Type | Required | Value required | Remarks |\n| :------------ | :------------------------------------------------ | :----- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | Unique ROR ID for the organization | String | TRUE | TRUE | |\n| name | The primary name of the organization | String | TRUE | TRUE | |\n| email_address | A contact mail address for the organization | String | FALSE | FALSE | Deprecated field - Not actively curating |\n| ip_addresses | IP address(es) associated with the organization | Array | FALSE | FALSE | Deprecated field - Not actively curating |\n| established | Year the organization was established (CE) | Number | TRUE | FALSE | |\n| types | Organization type | Array | TRUE | TRUE | Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other |\n| relationships | Related organizations in ROR | Array | TRUE | FALSE | Allowed relationship types: Parent, Child, Related, Predecessor, Successor |\n| addresses | The organization's location | Array | TRUE | TRUE | |\n| links | Official website of the organization | Array | TRUE | FALSE | |\n| aliases | Other names the organization is known by | Array | TRUE | FALSE | |\n| acronyms | Acronyms or initialisms for the organization name | Array | TRUE | FALSE | |\n| status | Whether the organization is active or not | String | TRUE | TRUE | Allowed values: Active, Inactive, Withdrawn |\n| wikipedia_url | Wikipedia link for the organization | String | TRUE | FALSE | |\n| labels | Name(s) for the organization in other language(s) | Array | TRUE | FALSE | |\n| country | Country where organization is located | Object | TRUE | TRUE | |\n| external_ids | Other identifiers for the organization | Array | TRUE | FALSE | Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS. |\n\n> 📘 All available fields and sub-fields\n> \n> See also the complete alphabetical list of [All ROR fields and sub-fields](doc:fields) in v1 of the ROR metadata schema.\n\n# Definitions and policies\n\nPolicies and expanded definitions for top-level metadata elements. See also [ROR Metadata Policies on GitHub](https://github.com/ror-community/ror-updates/wiki/ROR-Metadata-Policies).\n\n_\\* indicates a value is required_\n\n## `id*`\n\nThe ROR ID for the organization, created and assigned by ROR. See [ROR identifier pattern](doc:identifier) for more information on how the ROR ID is generated and structured. \n\n## `name*`\n\nThe official name of the organization used for affiliation purposes (this may be different than the organization's legal name).\n\nOnly one name can be included in the primary name field. ROR metadata includes additional fields (`aliases`, `labels`, `acronyms`) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.\n\nThe primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.\n\nROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.\n\nThe primary data source for the organization name and formatting thereof is the organization's website.\n\n## `email_address`\n\nThis field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema.\n\n## `ip_addresses`\n\nThis field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema. \n\n## `established`\n\nThe year the organization was established, written as four digits (YYYY).\n\n## `types*`\n\nThe type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.\n\nBased on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.\n\nAllowed types:\n\n**Education**: A university or similar institution involved in providing education and educating/employing researchers\n\n**Healthcare**: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.\n\n**Company**: A private for-profit corporate entity involved in conducting or sponsoring research.\n\n**Archive**: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.\n\n**Nonprofit**: A non-profit and non-governmental organization involved in conducting or funding research.\n\n**Government**: An organization that is part of or operated by a national or regional government and that conducts or supports research.\n\n**Facility**: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.\n\n**Other**: Use this category for any organization that does not fit the categories above.\n\n## `relationships`\n\nOne or more organizations that the organization is related to.\n\nFive types of relations are supported: _Parent_, _Child_, _Related_, _Predecessor_ and _Successor_. An organization can have multiple relationships but each relationship must be classified as Parent, Child, Related, Predecessor or Successor.\n\n### Inverse relationships\n\n_Parent_, _Child_ and _Related_ types must have corresponding relationships in the related record, except in the case of records with status _inactive_ or _withdrawn_. For example, if Organization A's record contains a relationship to Organization B with type _Parent_ (and both records have status _active_), Organization B's record must contain a corresponding relationship to Organization A with type _Child_.\n\n_Predecessor_ and _Successor_ types may optionally contain corresponding relationships in the related records, but they are not required. For example, if Organization A becomes inactive and contains a relationship to Organization B with type _Successor_, Organization B may or may not contain a corresponding relationship to Organization A with type _Predecessor_.\n\n### Relationships to inactive records\n\nRecords with status _active_ cannot contain relationships to records with status _inactive_ or _withdrawn_, except for relationships with type _Predecessor_.\n\nRecords with status _inactive_ or _withdrawn_ may have relationships to records with status _active_ for the sake of preserving the record data at the time the record status was changed to inactive or withdrawn. These are not considering current relationships and do not require corresponding relationships in related records.\n\n### Successor organizations\n\nRecords with a status of _inactive_ or _withdrawn_ may have one or more successor organizations listed in their relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn from the registry. If an organization simply changes its name, it will not receive a _Successor_; the existing ROR record for the organization will simply be modified with the new name in the `name` field and the previous name in the `aliases` field. \n\nDepending on your use case, you may wish to update references to _inactive_ ROR records in your database or application to the corresponding _Successor_ organization(s).\n\nIf you are depositing DOI records, the name & ROR ID of the organization should in general be kept historically correct. In other words, if an organization publishes content under a certain name and ROR ID, the name and ROR ID should remain the same in DOI metadata even if the organization later becomes inactive or is merged into a Successor organization. Relationships in ROR records ensure that research can still be tracked despite organizational changes. \n\n## `addresses*`\n\nLocation details for the organization. Location data comes from [GeoNames](https://www.geonames.org/).\n\nA city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country. Note too the existence of the separate top-level `country` element, which contains the name of the organization's country and its two-letter ISO country code.\n\nGeoNames data is licensed under a [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/).\n\n## `links`\n\nThe primary website of the organization. Only one URL should be associated with the record.\n\nIn the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.\n\n## `aliases`\n\nUsed for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical, but future iterations of the ROR schema may differentiate between the two.\n\n## `acronyms`\n\nOne or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).\n\n## `status*`\n\nIndication of whether the organization is active or not, based on a controlled list of status values. Allowed status values:\n\n**active:** An organization that is actively producing research outputs.\n\n**inactive:** An organization that has ceased operation or producing research outputs.\n\n**withdrawn:** A record that was created in error, such as a duplicate record, or a record that is not in scope for the registry.\n\nA record with a status of `inactive` or `withdrawn` may have one or more Successor organizations listed in its relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn. See [relationships](#relationships) for more information.\n\n_Note: Prior to 1 Dec 2022, all records had a status of active. Read more about this change in the [Dec 1 release notes](https://ror.readme.io/changelog/2022-12-01-organization-status-changes)_ \n\n## `wikipedia_url`\n\nA Wikipedia page for the organization. Only one URL should be associated with the record.\n\n## `labels`\n\nDisplays versions of the organization name in one or more languages other than that used in the primary `name` field, with a corresponding language tag based on the two-letter [ISO-639](https://www.loc.gov/standards/iso639-2/php/code_list.php) code.\n\n## `country*`\n\nIncludes the name and the two-letter [ISO-3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code for the organization's primary country. \n\n## `external_ids`\n\nOther identifiers for the organization (if available).\n\nROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).\n\nThere are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.\n\n# Example record\n\nSee the JSON structure in an example organization record.\n\n```json\n{\n \"id\":\"https://ror.org/013cjyk83\",\n \"name\":\"PSL Research University\",\n \"email_address\":null,\n \"ip_addresses\":[\n \n ],\n \"established\":2010,\n \"types\":[\n \"Education\"\n ],\n \"relationships\":[\n {\n \"label\":\"ESPCI Paris\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/03zx86w41\"\n },\n {\n \"label\":\"Subcellular Structure and Cellular Dynamics\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/04w11tv37\"\n },\n {\n \"label\":\"École Pratique des Hautes Études\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/046b3cj80\"\n }\n ],\n \"addresses\":[\n {\n \"lat\":48.854692,\n \"lng\":2.33781,\n \"state\":null,\n \"state_code\":null,\n \"city\":\"Paris\",\n \"geonames_city\":{\n \"id\":2988507,\n \"city\":\"Paris\",\n \"geonames_admin1\":{\n \"name\":\"Île-de-France\",\n \"id\":3012874,\n \"ascii_name\":\"Ile-de-France\",\n \"code\":\"FR.11\"\n },\n \"geonames_admin2\":{\n \"name\":\"Paris\",\n \"id\":2968815,\n \"ascii_name\":\"Paris\",\n \"code\":\"FR.11.75\"\n },\n \"license\":{\n \"attribution\":\"Data from geonames.org under a CC-BY 3.0 license\",\n \"license\":\"http://creativecommons.org/licenses/by/3.0/\"\n },\n \"nuts_level1\":{\n \"name\":\"ÎLE DE FRANCE\",\n \"code\":\"FR1\"\n },\n \"nuts_level2\":{\n \"name\":\"Île de France\",\n \"code\":\"FR10\"\n },\n \"nuts_level3\":{\n \"name\":\"Paris\",\n \"code\":\"FR101\"\n }\n },\n \"postcode\":null,\n \"primary\":false,\n \"line\":null,\n \"country_geonames_id\":3017382\n }\n ],\n \"links\":[\n \"https://www.psl.eu/en/university\"\n ],\n \"aliases\":[\n \"Université PSL\"\n ],\n \"acronyms\":[\n \"PSL\"\n ],\n \"status\":\"active\",\n \"wikipedia_url\":\"https://en.wikipedia.org/wiki/PSL_Research_University\",\n \"labels\":[\n {\n \"label\":\"Université de recherche Paris Sciences et Lettres\",\n \"iso639\":\"fr\"\n }\n ],\n \"country\":{\n \"country_name\":\"France\",\n \"country_code\":\"FR\"\n },\n \"external_ids\":{\n \"ISNI\":{\n \"preferred\":null,\n \"all\":[\n \"0000 0004 1784 3645\"\n ]\n },\n \"OrgRef\":{\n \"preferred\":null,\n \"all\":[\n \"31274670\"\n ]\n },\n \"Wikidata\":{\n \"preferred\":null,\n \"all\":[\n \"Q1163431\"\n ]\n },\n \"GRID\":{\n \"preferred\":\"grid.440907.e\",\n \"all\":\"grid.440907.e\"\n }\n }\n}\n```","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","resourceID":"60d25da0b85dae005598be27","resourceType":"page","baseUrl":"/","terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]}},"terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"mdx":false,"dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li>\n<a href=\"#fields\">Fields</a>\n</li>\n<li>\n<a href=\"#definitions-and-policies\">Definitions and policies</a>\n<ul>\n<li><a href=\"#id\"><code>id*</code></a></li>\n<li><a href=\"#name\"><code>name*</code></a></li>\n<li><a href=\"#email_address\"><code>email_address</code></a></li>\n<li><a href=\"#ip_addresses\"><code>ip_addresses</code></a></li>\n<li><a href=\"#established\"><code>established</code></a></li>\n<li><a href=\"#types\"><code>types*</code></a></li>\n<li><a href=\"#relationships\"><code>relationships</code></a></li>\n<li><a href=\"#addresses\"><code>addresses*</code></a></li>\n<li><a href=\"#links\"><code>links</code></a></li>\n<li><a href=\"#aliases\"><code>aliases</code></a></li>\n<li><a href=\"#acronyms\"><code>acronyms</code></a></li>\n<li><a href=\"#status\"><code>status*</code></a></li>\n<li><a href=\"#wikipedia_url\"><code>wikipedia_url</code></a></li>\n<li><a href=\"#labels\"><code>labels</code></a></li>\n<li><a href=\"#country\"><code>country*</code></a></li>\n<li><a href=\"#external_ids\"><code>external_ids</code></a></li>\n</ul>\n</li>\n<li>\n<a href=\"#example-record\">Example record</a>\n</li>\n</ul></li></ul></nav>","body":"<blockquote class=\"callout callout_default\" theme=\"1️⃣\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">1️⃣</span><p>ROR Schema v1</p></h2><p>This page documents ROR metadata schema v1. For documentation of ROR metadata schema v2, see <a href=\"https://ror.readme.io/v2/docs/data-structure\" target=\"\" title=\"\">https://ror.readme.io/v2/docs/data-structure</a>. You can also read more about ROR <a href=\"/docs/schema-versions\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-versions\">schema versions</a> and a summary of what&#x27;s new in ROR <a href=\"/docs/schema-v2\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-v2\">Schema 2.0</a>.</p></blockquote>\n<p>Version 1 of ROR&#x27;s data structure (aka its &quot;metadata schema&quot; or &quot;JSON schema&quot;) is based on <a href=\"https://digitalscience.figshare.com/search?q=GRID&amp;itemTypes=3\" target=\"\" title=\"\">Digital Science&#x27;s GRID</a>, which provided the original seed data for the registry. GRID retired its public releases as of 16 Sep 2021, and ROR began managing its data independently from GRID in March 2022. The full JSON schema used for generating and validating ROR records is available at <a href=\"https://github.com/ror-community/ror-schema\" target=\"\" title=\"\">https://github.com/ror-community/ror-schema</a>. </p>\n<p>The current ROR metadata schema inherited from GRID in 2019 is now unofficially known as version 1.0. After two rounds of community feedback in 2022/2023, <a href=\"/docs/schema-v2\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-v2\">metadata schema version 2.0</a> was developed and launched in April 2024. Version 1 of the ROR schema will continue to be available in the data dump and API at least through April 2025. Read more about ROR&#x27;s plans for metadata <a href=\"/docs/schema-versions\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-versions\">schema versioning</a>.</p>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"fields\"></div><div class=\"heading-text\"><div id=\"section-fields\" class=\"heading-anchor_backwardsCompatibility\"></div>Fields</div><a aria-label=\"Skip link to Fields\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#fields\"></a></h1>\n<p>Below are listed the top-level fields (or &quot;elements&quot;) in the ROR metadata schema along with their names, definitions, types, whether the field is required, and whether a value in the field is required. Queries to the ROR API will return all fields regardless of whether they have a value. JSON will include null values and empty arrays and objects if there is no value available for the given organization. </p>\n<blockquote class=\"callout callout_warn\" theme=\"🚧\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">🚧</span><p>New status &amp; relationship type values</p></h2><p>Beginning 1 Dec 2022, ROR supports new values <em>inactive</em> and <em>withdrawn</em> in <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">status</code> and <em>Predecessor</em> and <em>Successor</em> in <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">relationships.type</code>. Previously, all records had a status of <em>active</em> and relationships types were limited to <em>Parent</em>, <em>Child</em>, and <em>Related</em>. See updated field descriptions for <a href=\"#status\" target=\"\" title=\"\">status</a> and <a href=\"#relationships\" target=\"\" title=\"\">relationships</a> below and <a href=\"https://ror.readme.io/changelog/2022-12-01-organization-status-changes\" target=\"\" title=\"\">2022-12-01 changelog post </a> for more details.</p></blockquote>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<div class=\"rdmd-table\"><div class=\"rdmd-table-inner\"><table><thead><tr><th style=\"text-align:left\">Field name</th><th style=\"text-align:left\">Definition</th><th style=\"text-align:left\">Type</th><th style=\"text-align:left\">Required</th><th style=\"text-align:left\">Value required</th><th style=\"text-align:left\">Remarks</th></tr></thead><tbody><tr><td style=\"text-align:left\">id</td><td style=\"text-align:left\">Unique ROR ID for the organization</td><td style=\"text-align:left\">String</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">name</td><td style=\"text-align:left\">The primary name of the organization</td><td style=\"text-align:left\">String</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">email_address</td><td style=\"text-align:left\">A contact mail address for the organization</td><td style=\"text-align:left\">String</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">Deprecated field - Not actively curating</td></tr><tr><td style=\"text-align:left\">ip_addresses</td><td style=\"text-align:left\">IP address(es) associated with the organization</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">Deprecated field - Not actively curating</td></tr><tr><td style=\"text-align:left\">established</td><td style=\"text-align:left\">Year the organization was established (CE)</td><td style=\"text-align:left\">Number</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">types</td><td style=\"text-align:left\">Organization type</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other</td></tr><tr><td style=\"text-align:left\">relationships</td><td style=\"text-align:left\">Related organizations in ROR</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">Allowed relationship types: Parent, Child, Related, Predecessor, Successor</td></tr><tr><td style=\"text-align:left\">addresses</td><td style=\"text-align:left\">The organization&#x27;s location</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">links</td><td style=\"text-align:left\">Official website of the organization</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">aliases</td><td style=\"text-align:left\">Other names the organization is known by</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">acronyms</td><td style=\"text-align:left\">Acronyms or initialisms for the organization name</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">status</td><td style=\"text-align:left\">Whether the organization is active or not</td><td style=\"text-align:left\">String</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">Allowed values: Active, Inactive, Withdrawn</td></tr><tr><td style=\"text-align:left\">wikipedia_url</td><td style=\"text-align:left\">Wikipedia link for the organization</td><td style=\"text-align:left\">String</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">labels</td><td style=\"text-align:left\">Name(s) for the organization in other language(s)</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">country</td><td style=\"text-align:left\">Country where organization is located</td><td style=\"text-align:left\">Object</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\"></td></tr><tr><td style=\"text-align:left\">external_ids</td><td style=\"text-align:left\">Other identifiers for the organization</td><td style=\"text-align:left\">Array</td><td style=\"text-align:left\">TRUE</td><td style=\"text-align:left\">FALSE</td><td style=\"text-align:left\">Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS.</td></tr></tbody></table></div></div>\n<blockquote class=\"callout callout_info\" theme=\"📘\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">📘</span><p>All available fields and sub-fields</p></h2><p>See also the complete alphabetical list of <a href=\"/docs/fields\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"fields\">All ROR fields and sub-fields</a> in v1 of the ROR metadata schema.</p></blockquote>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"definitions-and-policies\"></div><div class=\"heading-text\"><div id=\"section-definitions-and-policies\" class=\"heading-anchor_backwardsCompatibility\"></div>Definitions and policies</div><a aria-label=\"Skip link to Definitions and policies\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#definitions-and-policies\"></a></h1>\n<p>Policies and expanded definitions for top-level metadata elements. See also <a href=\"https://github.com/ror-community/ror-updates/wiki/ROR-Metadata-Policies\" target=\"\" title=\"\">ROR Metadata Policies on GitHub</a>.</p>\n<p><em>* indicates a value is required</em></p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"id\"></div><div class=\"heading-text\"><div id=\"section-id\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">id*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#id\"></a></h2>\n<p>The ROR ID for the organization, created and assigned by ROR. See <a href=\"/docs/identifier\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"identifier\">ROR identifier pattern</a> for more information on how the ROR ID is generated and structured. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"name\"></div><div class=\"heading-text\"><div id=\"section-name\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">name*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#name\"></a></h2>\n<p>The official name of the organization used for affiliation purposes (this may be different than the organization&#x27;s legal name).</p>\n<p>Only one name can be included in the primary name field. ROR metadata includes additional fields (<button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">aliases</code>, <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">labels</code>, <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">acronyms</code>) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.</p>\n<p>The primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.</p>\n<p>ROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.</p>\n<p>The primary data source for the organization name and formatting thereof is the organization&#x27;s website.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"email_address\"></div><div class=\"heading-text\"><div id=\"section-email-address\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">email_address</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#email_address\"></a></h2>\n<p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"ip_addresses\"></div><div class=\"heading-text\"><div id=\"section-ip-addresses\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">ip_addresses</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#ip_addresses\"></a></h2>\n<p>This field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"established\"></div><div class=\"heading-text\"><div id=\"section-established\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">established</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#established\"></a></h2>\n<p>The year the organization was established, written as four digits (YYYY).</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"types\"></div><div class=\"heading-text\"><div id=\"section-types\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">types*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#types\"></a></h2>\n<p>The type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.</p>\n<p>Based on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.</p>\n<p>Allowed types:</p>\n<p><strong>Education</strong>: A university or similar institution involved in providing education and educating/employing researchers</p>\n<p><strong>Healthcare</strong>: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.</p>\n<p><strong>Company</strong>: A private for-profit corporate entity involved in conducting or sponsoring research.</p>\n<p><strong>Archive</strong>: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.</p>\n<p><strong>Nonprofit</strong>: A non-profit and non-governmental organization involved in conducting or funding research.</p>\n<p><strong>Government</strong>: An organization that is part of or operated by a national or regional government and that conducts or supports research.</p>\n<p><strong>Facility</strong>: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.</p>\n<p><strong>Other</strong>: Use this category for any organization that does not fit the categories above.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"relationships\"></div><div class=\"heading-text\"><div id=\"section-relationships\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">relationships</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#relationships\"></a></h2>\n<p>One or more organizations that the organization is related to.</p>\n<p>Five types of relations are supported: <em>Parent</em>, <em>Child</em>, <em>Related</em>, <em>Predecessor</em> and <em>Successor</em>. An organization can have multiple relationships but each relationship must be classified as Parent, Child, Related, Predecessor or Successor.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"inverse-relationships\"></div><div class=\"heading-text\"><div id=\"section-inverse-relationships\" class=\"heading-anchor_backwardsCompatibility\"></div>Inverse relationships</div><a aria-label=\"Skip link to Inverse relationships\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#inverse-relationships\"></a></h3>\n<p><em>Parent</em>, <em>Child</em> and <em>Related</em> types must have corresponding relationships in the related record, except in the case of records with status <em>inactive</em> or <em>withdrawn</em>. For example, if Organization A&#x27;s record contains a relationship to Organization B with type <em>Parent</em> (and both records have status <em>active</em>), Organization B&#x27;s record must contain a corresponding relationship to Organization A with type <em>Child</em>.</p>\n<p><em>Predecessor</em> and <em>Successor</em> types may optionally contain corresponding relationships in the related records, but they are not required. For example, if Organization A becomes inactive and contains a relationship to Organization B with type <em>Successor</em>, Organization B may or may not contain a corresponding relationship to Organization A with type <em>Predecessor</em>.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"relationships-to-inactive-records\"></div><div class=\"heading-text\"><div id=\"section-relationships-to-inactive-records\" class=\"heading-anchor_backwardsCompatibility\"></div>Relationships to inactive records</div><a aria-label=\"Skip link to Relationships to inactive records\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#relationships-to-inactive-records\"></a></h3>\n<p>Records with status <em>active</em> cannot contain relationships to records with status <em>inactive</em> or <em>withdrawn</em>, except for relationships with type <em>Predecessor</em>.</p>\n<p>Records with status <em>inactive</em> or <em>withdrawn</em> may have relationships to records with status <em>active</em> for the sake of preserving the record data at the time the record status was changed to inactive or withdrawn. These are not considering current relationships and do not require corresponding relationships in related records.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"successor-organizations\"></div><div class=\"heading-text\"><div id=\"section-successor-organizations\" class=\"heading-anchor_backwardsCompatibility\"></div>Successor organizations</div><a aria-label=\"Skip link to Successor organizations\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#successor-organizations\"></a></h3>\n<p>Records with a status of <em>inactive</em> or <em>withdrawn</em> may have one or more successor organizations listed in their relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn from the registry. If an organization simply changes its name, it will not receive a <em>Successor</em>; the existing ROR record for the organization will simply be modified with the new name in the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">name</code> field and the previous name in the <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">aliases</code> field. </p>\n<p>Depending on your use case, you may wish to update references to <em>inactive</em> ROR records in your database or application to the corresponding <em>Successor</em> organization(s).</p>\n<p>If you are depositing DOI records, the name &amp; ROR ID of the organization should in general be kept historically correct. In other words, if an organization publishes content under a certain name and ROR ID, the name and ROR ID should remain the same in DOI metadata even if the organization later becomes inactive or is merged into a Successor organization. Relationships in ROR records ensure that research can still be tracked despite organizational changes. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"addresses\"></div><div class=\"heading-text\"><div id=\"section-addresses\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">addresses*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#addresses\"></a></h2>\n<p>Location details for the organization. Location data comes from <a href=\"https://www.geonames.org/\" target=\"\" title=\"\">GeoNames</a>.</p>\n<p>A city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country. Note too the existence of the separate top-level <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">country</code> element, which contains the name of the organization&#x27;s country and its two-letter ISO country code.</p>\n<p>GeoNames data is licensed under a <a href=\"https://creativecommons.org/licenses/by/4.0/\" target=\"\" title=\"\">Creative Commons Attribution 4.0 license</a>.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"links\"></div><div class=\"heading-text\"><div id=\"section-links\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">links</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#links\"></a></h2>\n<p>The primary website of the organization. Only one URL should be associated with the record.</p>\n<p>In the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"aliases\"></div><div class=\"heading-text\"><div id=\"section-aliases\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">aliases</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#aliases\"></a></h2>\n<p>Used for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical, but future iterations of the ROR schema may differentiate between the two.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"acronyms\"></div><div class=\"heading-text\"><div id=\"section-acronyms\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">acronyms</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#acronyms\"></a></h2>\n<p>One or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"status\"></div><div class=\"heading-text\"><div id=\"section-status\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">status*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#status\"></a></h2>\n<p>Indication of whether the organization is active or not, based on a controlled list of status values. Allowed status values:</p>\n<p><strong>active:</strong> An organization that is actively producing research outputs.</p>\n<p><strong>inactive:</strong> An organization that has ceased operation or producing research outputs.</p>\n<p><strong>withdrawn:</strong> A record that was created in error, such as a duplicate record, or a record that is not in scope for the registry.</p>\n<p>A record with a status of <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">inactive</code> or <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">withdrawn</code> may have one or more Successor organizations listed in its relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn. See <a href=\"#relationships\" target=\"\" title=\"\">relationships</a> for more information.</p>\n<p><em>Note: Prior to 1 Dec 2022, all records had a status of active. Read more about this change in the <a href=\"https://ror.readme.io/changelog/2022-12-01-organization-status-changes\" target=\"\" title=\"\">Dec 1 release notes</a></em> </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"wikipedia_url\"></div><div class=\"heading-text\"><div id=\"section-wikipedia-url\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">wikipedia_url</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#wikipedia_url\"></a></h2>\n<p>A Wikipedia page for the organization. Only one URL should be associated with the record.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"labels\"></div><div class=\"heading-text\"><div id=\"section-labels\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">labels</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#labels\"></a></h2>\n<p>Displays versions of the organization name in one or more languages other than that used in the primary <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">name</code> field, with a corresponding language tag based on the two-letter <a href=\"https://www.loc.gov/standards/iso639-2/php/code_list.php\" target=\"\" title=\"\">ISO-639</a> code.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"country\"></div><div class=\"heading-text\"><div id=\"section-country\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">country*</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#country\"></a></h2>\n<p>Includes the name and the two-letter <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\" target=\"\" title=\"\">ISO-3166</a> country code for the organization&#x27;s primary country. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"external_ids\"></div><div class=\"heading-text\"><div id=\"section-external-ids\" class=\"heading-anchor_backwardsCompatibility\"></div><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">external_ids</code></div><a aria-label=\"Skip link to [object Object]\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#external_ids\"></a></h2>\n<p>Other identifiers for the organization (if available).</p>\n<p>ROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).</p>\n<p>There are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.</p>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"example-record\"></div><div class=\"heading-text\"><div id=\"section-example-record\" class=\"heading-anchor_backwardsCompatibility\"></div>Example record</div><a aria-label=\"Skip link to Example record\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#example-record\"></a></h1>\n<p>See the JSON structure in an example organization record.</p>\n<div class=\"CodeTabs CodeTabs_initial theme-light\"><div class=\"CodeTabs-toolbar\" role=\"tablist\"><button aria-selected=\"true\" class=\"CodeTabs_active\" role=\"tab\" type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\" role=\"tabpanel\"><pre><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang-json theme-light\" data-lang=\"json\" name=\"\" tabindex=\"0\">{\n &quot;id&quot;:&quot;https://ror.org/013cjyk83&quot;,\n &quot;name&quot;:&quot;PSL Research University&quot;,\n &quot;email_address&quot;:null,\n &quot;ip_addresses&quot;:[\n \n ],\n &quot;established&quot;:2010,\n &quot;types&quot;:[\n &quot;Education&quot;\n ],\n &quot;relationships&quot;:[\n {\n &quot;label&quot;:&quot;ESPCI Paris&quot;,\n &quot;type&quot;:&quot;Child&quot;,\n &quot;id&quot;:&quot;https://ror.org/03zx86w41&quot;\n },\n {\n &quot;label&quot;:&quot;Subcellular Structure and Cellular Dynamics&quot;,\n &quot;type&quot;:&quot;Child&quot;,\n &quot;id&quot;:&quot;https://ror.org/04w11tv37&quot;\n },\n {\n &quot;label&quot;:&quot;École Pratique des Hautes Études&quot;,\n &quot;type&quot;:&quot;Child&quot;,\n &quot;id&quot;:&quot;https://ror.org/046b3cj80&quot;\n }\n ],\n &quot;addresses&quot;:[\n {\n &quot;lat&quot;:48.854692,\n &quot;lng&quot;:2.33781,\n &quot;state&quot;:null,\n &quot;state_code&quot;:null,\n &quot;city&quot;:&quot;Paris&quot;,\n &quot;geonames_city&quot;:{\n &quot;id&quot;:2988507,\n &quot;city&quot;:&quot;Paris&quot;,\n &quot;geonames_admin1&quot;:{\n &quot;name&quot;:&quot;Île-de-France&quot;,\n &quot;id&quot;:3012874,\n &quot;ascii_name&quot;:&quot;Ile-de-France&quot;,\n &quot;code&quot;:&quot;FR.11&quot;\n },\n &quot;geonames_admin2&quot;:{\n &quot;name&quot;:&quot;Paris&quot;,\n &quot;id&quot;:2968815,\n &quot;ascii_name&quot;:&quot;Paris&quot;,\n &quot;code&quot;:&quot;FR.11.75&quot;\n },\n &quot;license&quot;:{\n &quot;attribution&quot;:&quot;Data from geonames.org under a CC-BY 3.0 license&quot;,\n &quot;license&quot;:&quot;http://creativecommons.org/licenses/by/3.0/&quot;\n },\n &quot;nuts_level1&quot;:{\n &quot;name&quot;:&quot;ÎLE DE FRANCE&quot;,\n &quot;code&quot;:&quot;FR1&quot;\n },\n &quot;nuts_level2&quot;:{\n &quot;name&quot;:&quot;Île de France&quot;,\n &quot;code&quot;:&quot;FR10&quot;\n },\n &quot;nuts_level3&quot;:{\n &quot;name&quot;:&quot;Paris&quot;,\n &quot;code&quot;:&quot;FR101&quot;\n }\n },\n &quot;postcode&quot;:null,\n &quot;primary&quot;:false,\n &quot;line&quot;:null,\n &quot;country_geonames_id&quot;:3017382\n }\n ],\n &quot;links&quot;:[\n &quot;https://www.psl.eu/en/university&quot;\n ],\n &quot;aliases&quot;:[\n &quot;Université PSL&quot;\n ],\n &quot;acronyms&quot;:[\n &quot;PSL&quot;\n ],\n &quot;status&quot;:&quot;active&quot;,\n &quot;wikipedia_url&quot;:&quot;https://en.wikipedia.org/wiki/PSL_Research_University&quot;,\n &quot;labels&quot;:[\n {\n &quot;label&quot;:&quot;Université de recherche Paris Sciences et Lettres&quot;,\n &quot;iso639&quot;:&quot;fr&quot;\n }\n ],\n &quot;country&quot;:{\n &quot;country_name&quot;:&quot;France&quot;,\n &quot;country_code&quot;:&quot;FR&quot;\n },\n &quot;external_ids&quot;:{\n &quot;ISNI&quot;:{\n &quot;preferred&quot;:null,\n &quot;all&quot;:[\n &quot;0000 0004 1784 3645&quot;\n ]\n },\n &quot;OrgRef&quot;:{\n &quot;preferred&quot;:null,\n &quot;all&quot;:[\n &quot;31274670&quot;\n ]\n },\n &quot;Wikidata&quot;:{\n &quot;preferred&quot;:null,\n &quot;all&quot;:[\n &quot;Q1163431&quot;\n ]\n },\n &quot;GRID&quot;:{\n &quot;preferred&quot;:&quot;grid.440907.e&quot;,\n &quot;all&quot;:&quot;grid.440907.e&quot;\n }\n }\n}\n</code></pre></div></div>"}},"doc":{"metadata":{"image":[],"title":"ROR Data Structure","description":"This document outlines the policies and definitions for top-level metadata elements in the ROR schema, including required fields such as organization ID, name, type, establishment year, relationships, addresses, status, and external identifiers.","keywords":"schema, metadata","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"next":{"description":"","pages":[]},"algolia":{"recordCount":23,"publishPending":false,"translationFailure":false,"updatedAt":"2024-11-14T22:12:29.625Z"},"title":"Data structure","icon":"","updates":[],"type":"basic","slug":"data-structure","excerpt":"","body":"> 1️⃣ ROR Schema v1\n> \n> This page documents ROR metadata schema v1. For documentation of ROR metadata schema v2, see <https://ror.readme.io/v2/docs/data-structure>. You can also read more about ROR [schema versions](doc:schema-versions) and a summary of what's new in ROR [Schema 2.0](doc:schema-v2).\n\nVersion 1 of ROR's data structure (aka its \"metadata schema\" or \"JSON schema\") is based on [Digital Science's GRID](https://digitalscience.figshare.com/search?q=GRID&itemTypes=3), which provided the original seed data for the registry. GRID retired its public releases as of 16 Sep 2021, and ROR began managing its data independently from GRID in March 2022. The full JSON schema used for generating and validating ROR records is available at <https://github.com/ror-community/ror-schema>. \n\nThe current ROR metadata schema inherited from GRID in 2019 is now unofficially known as version 1.0. After two rounds of community feedback in 2022/2023, [metadata schema version 2.0](doc:schema-v2) was developed and launched in April 2024. Version 1 of the ROR schema will continue to be available in the data dump and API at least through April 2025. Read more about ROR's plans for metadata [schema versioning](doc:schema-versions).\n\n# Fields\n\nBelow are listed the top-level fields (or \"elements\") in the ROR metadata schema along with their names, definitions, types, whether the field is required, and whether a value in the field is required. Queries to the ROR API will return all fields regardless of whether they have a value. JSON will include null values and empty arrays and objects if there is no value available for the given organization. \n\n> 🚧 New status & relationship type values\n> \n> Beginning 1 Dec 2022, ROR supports new values _inactive_ and _withdrawn_ in `status` and _Predecessor_ and _Successor_ in `relationships.type`. Previously, all records had a status of _active_ and relationships types were limited to _Parent_, _Child_, and _Related_. See updated field descriptions for [status](#status) and [relationships](#relationships) below and [2022-12-01 changelog post ](https://ror.readme.io/changelog/2022-12-01-organization-status-changes) for more details.\n\n| Field name | Definition | Type | Required | Value required | Remarks |\n| :------------ | :------------------------------------------------ | :----- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | Unique ROR ID for the organization | String | TRUE | TRUE | |\n| name | The primary name of the organization | String | TRUE | TRUE | |\n| email_address | A contact mail address for the organization | String | FALSE | FALSE | Deprecated field - Not actively curating |\n| ip_addresses | IP address(es) associated with the organization | Array | FALSE | FALSE | Deprecated field - Not actively curating |\n| established | Year the organization was established (CE) | Number | TRUE | FALSE | |\n| types | Organization type | Array | TRUE | TRUE | Allowed types: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, Other |\n| relationships | Related organizations in ROR | Array | TRUE | FALSE | Allowed relationship types: Parent, Child, Related, Predecessor, Successor |\n| addresses | The organization's location | Array | TRUE | TRUE | |\n| links | Official website of the organization | Array | TRUE | FALSE | |\n| aliases | Other names the organization is known by | Array | TRUE | FALSE | |\n| acronyms | Acronyms or initialisms for the organization name | Array | TRUE | FALSE | |\n| status | Whether the organization is active or not | String | TRUE | TRUE | Allowed values: Active, Inactive, Withdrawn |\n| wikipedia_url | Wikipedia link for the organization | String | TRUE | FALSE | |\n| labels | Name(s) for the organization in other language(s) | Array | TRUE | FALSE | |\n| country | Country where organization is located | Object | TRUE | TRUE | |\n| external_ids | Other identifiers for the organization | Array | TRUE | FALSE | Allowed external IDs: Crossref Funder ID (FundRef), ISNI, Wikidata. Other external IDs not actively curated include GRID, OrgRef, HESA, UCAS, UKPRN, CNRS. |\n\n> 📘 All available fields and sub-fields\n> \n> See also the complete alphabetical list of [All ROR fields and sub-fields](doc:fields) in v1 of the ROR metadata schema.\n\n# Definitions and policies\n\nPolicies and expanded definitions for top-level metadata elements. See also [ROR Metadata Policies on GitHub](https://github.com/ror-community/ror-updates/wiki/ROR-Metadata-Policies).\n\n_\\* indicates a value is required_\n\n## `id*`\n\nThe ROR ID for the organization, created and assigned by ROR. See [ROR identifier pattern](doc:identifier) for more information on how the ROR ID is generated and structured. \n\n## `name*`\n\nThe official name of the organization used for affiliation purposes (this may be different than the organization's legal name).\n\nOnly one name can be included in the primary name field. ROR metadata includes additional fields (`aliases`, `labels`, `acronyms`) for other versions of an organization’s name so that these versions of the name can also be represented in the metadata record and so that the organization can be discoverable in the registry no matter which version of a name is input by a user in searches and API queries.\n\nThe primary name field defaults to English when an English version of an organization’s name is available, but primary names may also be in non-English languages.\n\nROR metadata can support multiple languages and character sets. However, the primary name field uses Latin (Roman) characters only.\n\nThe primary data source for the organization name and formatting thereof is the organization's website.\n\n## `email_address`\n\nThis field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema.\n\n## `ip_addresses`\n\nThis field is deprecated and is empty or null in ROR records. It will be removed in version 2 of the ROR schema. \n\n## `established`\n\nThe year the organization was established, written as four digits (YYYY).\n\n## `types*`\n\nThe type of organization based on a controlled list of categories. An organization always has a type. ROR metadata can support multiple types for a given organization, but in most cases, there will just be one type associated with the organization.\n\nBased on the available information about the organization, curators will use their judgement in determining the appropriate category to assign.\n\nAllowed types:\n\n**Education**: A university or similar institution involved in providing education and educating/employing researchers\n\n**Healthcare**: A medical care facility such as hospital or medical clinic. Excludes medical schools, which should be categorized as “Education”.\n\n**Company**: A private for-profit corporate entity involved in conducting or sponsoring research.\n\n**Archive**: An organization involved in stewarding research and cultural heritage materials. Includes libraries, museums, and zoos.\n\n**Nonprofit**: A non-profit and non-governmental organization involved in conducting or funding research.\n\n**Government**: An organization that is part of or operated by a national or regional government and that conducts or supports research.\n\n**Facility**: A specialized facility where research takes place, such as a laboratory or telescope or dedicated research area.\n\n**Other**: Use this category for any organization that does not fit the categories above.\n\n## `relationships`\n\nOne or more organizations that the organization is related to.\n\nFive types of relations are supported: _Parent_, _Child_, _Related_, _Predecessor_ and _Successor_. An organization can have multiple relationships but each relationship must be classified as Parent, Child, Related, Predecessor or Successor.\n\n### Inverse relationships\n\n_Parent_, _Child_ and _Related_ types must have corresponding relationships in the related record, except in the case of records with status _inactive_ or _withdrawn_. For example, if Organization A's record contains a relationship to Organization B with type _Parent_ (and both records have status _active_), Organization B's record must contain a corresponding relationship to Organization A with type _Child_.\n\n_Predecessor_ and _Successor_ types may optionally contain corresponding relationships in the related records, but they are not required. For example, if Organization A becomes inactive and contains a relationship to Organization B with type _Successor_, Organization B may or may not contain a corresponding relationship to Organization A with type _Predecessor_.\n\n### Relationships to inactive records\n\nRecords with status _active_ cannot contain relationships to records with status _inactive_ or _withdrawn_, except for relationships with type _Predecessor_.\n\nRecords with status _inactive_ or _withdrawn_ may have relationships to records with status _active_ for the sake of preserving the record data at the time the record status was changed to inactive or withdrawn. These are not considering current relationships and do not require corresponding relationships in related records.\n\n### Successor organizations\n\nRecords with a status of _inactive_ or _withdrawn_ may have one or more successor organizations listed in their relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn from the registry. If an organization simply changes its name, it will not receive a _Successor_; the existing ROR record for the organization will simply be modified with the new name in the `name` field and the previous name in the `aliases` field. \n\nDepending on your use case, you may wish to update references to _inactive_ ROR records in your database or application to the corresponding _Successor_ organization(s).\n\nIf you are depositing DOI records, the name & ROR ID of the organization should in general be kept historically correct. In other words, if an organization publishes content under a certain name and ROR ID, the name and ROR ID should remain the same in DOI metadata even if the organization later becomes inactive or is merged into a Successor organization. Relationships in ROR records ensure that research can still be tracked despite organizational changes. \n\n## `addresses*`\n\nLocation details for the organization. Location data comes from [GeoNames](https://www.geonames.org/).\n\nA city or specified location is required to populate corresponding data from GeoNames, such as latitude/longitude coordinates, state/province/region, and country. Note too the existence of the separate top-level `country` element, which contains the name of the organization's country and its two-letter ISO country code.\n\nGeoNames data is licensed under a [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/).\n\n## `links`\n\nThe primary website of the organization. Only one URL should be associated with the record.\n\nIn the case of websites with translated versions that use a language suffix like “/en”, the generic URL (without the language suffix) is used as long as the website resolves without it. Otherwise, the English version will be used.\n\n## `aliases`\n\nUsed for one or more alternate forms of the organization name that may be used for affiliation purposes but are not considered the primary name according to official organization policy and/or for the purposes of ROR metadata handling. This field may include both current and historical name variants. ROR does not currently identify which aliases are current versus historical, but future iterations of the ROR schema may differentiate between the two.\n\n## `acronyms`\n\nOne or more official acronyms or initialisms for the organization, typically consisting of the first letters of the words in the organization name (e.g., UCLA for “University of California, Los Angeles”).\n\n## `status*`\n\nIndication of whether the organization is active or not, based on a controlled list of status values. Allowed status values:\n\n**active:** An organization that is actively producing research outputs.\n\n**inactive:** An organization that has ceased operation or producing research outputs.\n\n**withdrawn:** A record that was created in error, such as a duplicate record, or a record that is not in scope for the registry.\n\nA record with a status of `inactive` or `withdrawn` may have one or more Successor organizations listed in its relationships. Successor relationships indicate that another organization continues the work of an organization that has become inactive or has been withdrawn. See [relationships](#relationships) for more information.\n\n_Note: Prior to 1 Dec 2022, all records had a status of active. Read more about this change in the [Dec 1 release notes](https://ror.readme.io/changelog/2022-12-01-organization-status-changes)_ \n\n## `wikipedia_url`\n\nA Wikipedia page for the organization. Only one URL should be associated with the record.\n\n## `labels`\n\nDisplays versions of the organization name in one or more languages other than that used in the primary `name` field, with a corresponding language tag based on the two-letter [ISO-639](https://www.loc.gov/standards/iso639-2/php/code_list.php) code.\n\n## `country*`\n\nIncludes the name and the two-letter [ISO-3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code for the organization's primary country. \n\n## `external_ids`\n\nOther identifiers for the organization (if available).\n\nROR maps its IDs to the following other identifiers: GRID, Wikidata, ISNI, and Crossref Funder Registry (formerly “Fundref”).\n\nThere are additional IDs in the existing ROR metadata that are primarily legacy identifiers. These will not be actively curated in new records for the time being: OrgRef, UCAS, CNRS, HESA, UKPRN.\n\n# Example record\n\nSee the JSON structure in an example organization record.\n\n```json\n{\n \"id\":\"https://ror.org/013cjyk83\",\n \"name\":\"PSL Research University\",\n \"email_address\":null,\n \"ip_addresses\":[\n \n ],\n \"established\":2010,\n \"types\":[\n \"Education\"\n ],\n \"relationships\":[\n {\n \"label\":\"ESPCI Paris\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/03zx86w41\"\n },\n {\n \"label\":\"Subcellular Structure and Cellular Dynamics\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/04w11tv37\"\n },\n {\n \"label\":\"École Pratique des Hautes Études\",\n \"type\":\"Child\",\n \"id\":\"https://ror.org/046b3cj80\"\n }\n ],\n \"addresses\":[\n {\n \"lat\":48.854692,\n \"lng\":2.33781,\n \"state\":null,\n \"state_code\":null,\n \"city\":\"Paris\",\n \"geonames_city\":{\n \"id\":2988507,\n \"city\":\"Paris\",\n \"geonames_admin1\":{\n \"name\":\"Île-de-France\",\n \"id\":3012874,\n \"ascii_name\":\"Ile-de-France\",\n \"code\":\"FR.11\"\n },\n \"geonames_admin2\":{\n \"name\":\"Paris\",\n \"id\":2968815,\n \"ascii_name\":\"Paris\",\n \"code\":\"FR.11.75\"\n },\n \"license\":{\n \"attribution\":\"Data from geonames.org under a CC-BY 3.0 license\",\n \"license\":\"http://creativecommons.org/licenses/by/3.0/\"\n },\n \"nuts_level1\":{\n \"name\":\"ÎLE DE FRANCE\",\n \"code\":\"FR1\"\n },\n \"nuts_level2\":{\n \"name\":\"Île de France\",\n \"code\":\"FR10\"\n },\n \"nuts_level3\":{\n \"name\":\"Paris\",\n \"code\":\"FR101\"\n }\n },\n \"postcode\":null,\n \"primary\":false,\n \"line\":null,\n \"country_geonames_id\":3017382\n }\n ],\n \"links\":[\n \"https://www.psl.eu/en/university\"\n ],\n \"aliases\":[\n \"Université PSL\"\n ],\n \"acronyms\":[\n \"PSL\"\n ],\n \"status\":\"active\",\n \"wikipedia_url\":\"https://en.wikipedia.org/wiki/PSL_Research_University\",\n \"labels\":[\n {\n \"label\":\"Université de recherche Paris Sciences et Lettres\",\n \"iso639\":\"fr\"\n }\n ],\n \"country\":{\n \"country_name\":\"France\",\n \"country_code\":\"FR\"\n },\n \"external_ids\":{\n \"ISNI\":{\n \"preferred\":null,\n \"all\":[\n \"0000 0004 1784 3645\"\n ]\n },\n \"OrgRef\":{\n \"preferred\":null,\n \"all\":[\n \"31274670\"\n ]\n },\n \"Wikidata\":{\n \"preferred\":null,\n \"all\":[\n \"Q1163431\"\n ]\n },\n \"GRID\":{\n \"preferred\":\"grid.440907.e\",\n \"all\":\"grid.440907.e\"\n }\n }\n}\n```","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"ror-data-structure","slugUpdatedAt":"2024-04-26T14:55:10.310Z","revision":169,"_id":"60d25da0b85dae005598be27","pendingAlgoliaPublish":false,"createdAt":"2021-06-22T22:01:04.607Z","updatedAt":"2024-11-14T22:12:29.631Z","user":"62a72c1fbac94d016a0d28fe","category":{"title":"ROR Metadata","slug":"ror-metadata","order":3,"reference":false,"_id":"65ec6c03aff86d0072a566d7","project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2024-03-09T14:02:43.834Z","__v":0,"type":"guide","id":"65ec6c03aff86d0072a566d7"},"project":"6058e47681775f002de04832","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"pdfStatus":"","_id":"6058e47681775f002de04837","project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"__v":6,"parentDoc":null,"lastUpdatedHash":"d192cb6c964aadda731b333ce23080865ca437c9","isApi":false,"tutorials":[],"id":"60d25da0b85dae005598be27"},"hideTOC":false,"meta":{"_id":"60d25da0b85dae005598be27","description":"This document outlines the policies and definitions for top-level metadata elements in the ROR schema, including required fields such as organization ID, name, type, establishment year, relationships, addresses, status, and external identifiers.","hidden":false,"image":[],"keywords":"schema, metadata","metaTitle":"ROR Data Structure","parent":null,"robots":"index","slug":"data-structure","title":"Data structure","type":"docs"},"slugUrl":"/docs/data-structure","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"project":{"_id":"6058e47681775f002de04832","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#44A28F","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"row","link_logo_to_url":true,"theme":"solid","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"logo":["https://files.readme.io/4330c08-small-ror-logo-large.png","4330c08-small-ror-logo-large.png",125,80,"#000000","https://files.readme.io/e784d79-ror-logo-large.png","64c16bb48938310012444a6e"],"logo_white":["https://files.readme.io/dacd566-white-logo.png","dacd566-white-logo.png",125,80,"#ffffff","65ef46717fce1c0036177477"],"logo_white_use":false,"favicon":["https://files.readme.io/a931430-small-ror-icon-profile_2.png","ror-icon-profile (2).png",32,32,"#d8e0de","https://files.readme.io/a2115cf-ror-icon-profile_2.png"],"stylesheet":"","stylesheet_hub2":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"Other resources you might find helpful","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"ROR Documentation","text":"Comprehensive technical documentation for the Research Organization Registry (ROR), including ROR's metadata schema and REST API, plus implementation guides. Let's ROR!","_id":"6058e47681775f002de04834"}],"showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"colorScheme":"light","logo_large":true,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"","childrenProjects":[],"derivedPlan":"opensource","description":"Technical documentation for ROR, the Research Organization Registry, a global, community-led registry of open persistent identifiers for research organizations.","error404":"","experiments":[],"first_page":"landing","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"newEditor":true,"oldMarkdown":false,"useReactApp":true,"newMarkdownBetaProgram":true,"referenceRedesign":false,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"allowApiExplorerJsonEditor":false,"newHeader":false,"auth0Oauth":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":false,"metricsV2":true,"enableRealtimeExperiences":false,"newEditorDash":true,"allowDarkMode":false,"forceDarkMode":false,"reviewWorkflow":true,"star":false,"useReactGLP":false,"disablePasswordlessLogin":false,"myDevelopers":false,"superHub":false,"allowReusableOTPs":false,"developerDashboard":false,"owlbotAi":false,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":false,"customBlocks":false,"devDashHub":false,"disableAutoTranslate":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"billingRedesignEnabled":true,"disableSignups":false,"passwordlessLogin":"default","developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"enableOidc":false,"changelogRssAlwaysPublic":false,"customComponents":false,"developerViewUsersData":false,"disableDiscussionSpamRecaptchaBypass":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false},"fullBaseUrl":"https://ror.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"ROR v1 will be deprecated in 2025","text":"Have you switched yet to v2 of the ROR schema and API? Remember that v1 of ROR will be deprecated in 2025. Read more about [version 2 in the changelog](https://ror.readme.io/v2/changelog/2024-04-11-schema-api-v2) and flip the toggle to switch between documentation for v1 and v2."},{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"name":"ROR","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"freelaunch","planOverride":"opensource","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"opensource","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":false,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":false,"points":2}},"percentScore":25,"totalScore":70},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":true},"stable":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"subdomain":"ror","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Report a bug or request a feature","url":"https://github.com/ror-community/ror-roadmap/issues/new/choose"},{"type":"url","text":"Contact support","url":"mailto:support@ror.org"}],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/docs/data-structure"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2021-04-05T18:39:50.145Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://ror.org","versions":[{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},{"_id":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","66072096d9631f0054e8c0ea","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","66072096d9631f0054e8c0ee","66072096d9631f0054e8c0ef","66072096d9631f0054e8c0f0","66072097d9631f0054e8c11a"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2024-03-29T20:12:06.845Z","__v":0,"updatedAt":"2024-04-11T20:46:41.478Z","forked_from":"6058e47681775f002de04837"}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"canonical_url":null,"description":"Technical documentation for ROR, the Research Organization Registry, a global, community-led registry of open persistent identifiers for research organizations.","parent":null,"homepage_url":"https://ror.org","id":"6058e47681775f002de04832","is_migrated":false,"name":"ROR","redirects":[],"sitemap":"disabled","subdomain":"ror","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"enabled"},"plan":{"type":"opensource","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2021-04-05T18:39:50.145Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"enabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#44A28F","link_color":null,"theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":"Other resources you might find helpful","footer":{"readme_logo":"show"},"logo":{"size":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/dacd566-white-logo.png","name":"dacd566-white-logo.png","width":125,"height":80,"color":"#ffffff","links":{"original_url":"65ef46717fce1c0036177477"}},"main":{"uri":"/images/64c16bb48938310012444a6e","url":"https://files.readme.io/4330c08-small-ror-logo-large.png","name":"4330c08-small-ror-logo-large.png","width":125,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/e784d79-ror-logo-large.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/a931430-small-ror-icon-profile_2.png","name":"ror-icon-profile (2).png","width":32,"height":32,"color":"#d8e0de","links":{"original_url":"https://files.readme.io/a2115cf-ror-icon-profile_2.png"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"link_url","title":"Report a bug or request a feature","url":"https://github.com/ror-community/ror-roadmap/issues/new/choose","custom_page":null},{"type":"link_url","title":"Contact support","url":"mailto:support@ror.org","custom_page":null}],"logo_link":"homepage","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"disabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"}},"reqUrl":"/docs/data-structure","version":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,4935,6841,6722,1936,1202,5798,4002,3787,1080,9852,8684,7971,153,1313,1343,6060,1666,9575,6922,2859,2144,2637,4674,1731,8063,9141,5408,4793,2616,3412,3221,7327,7285,3307,1231,3826,2402,1948,4467,3859,678,2578]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","core-icons-alert-circle-svg","Footer","routes-Landing","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","routes-PageNotFound","core-icons-arrow-right-svg","CustomPage","routes-Changelog","List","core-icons-arrow-up-right-svg","Post","routes-Discuss","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","routes-Dash-ChatGPT-CopilotInstalledPage","Page","rmdx","routes-Tutorials","core-icons-chevron-down-svg","routes-CustomPage","core-icons-webhook-svg","core-icons-eye-off-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/1231.f80a04007595f4936e51.js"></script> <script async data-chunk="routes-Dash-ChatGPT-CopilotInstalledPage" src="https://cdn.readme.io/public/hub/web/routes-Dash-ChatGPT-CopilotInstalledPage.905756735b64839665ac.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"ODczNzdiMDdiZDc1ZWRiOGQyYWVlYzVjMTdiMjg3ZmEwNWUyZDk3YWJlMDc5ZTliNmFhNTE2ZWY3ZDhiOGUyZnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODM3KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:6058e47681775f002de04832),(version:none,version:6058e47681775f002de04837),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"6058e47681775f002de04832","name":"ROR","subdomain":"ror","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>