ROR

<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><meta charset="utf-8"><meta name="readme-deploy" content="5.322.0"><meta name="readme-subdomain" content="ror"><meta name="readme-version" content="2"><title>ROR</title><meta name="description"><meta property="og:title" content="ROR"><meta property="og:description"><meta property="og:site_name" content="ROR"><meta name="twitter:title" content="ROR"><meta name="twitter:description"><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/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png"><meta name="twitter:image" content="https://files.readme.io/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.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/"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1743783937684"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.css"> <link data-chunk="SuperHub-CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.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="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="Footer" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.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="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/7188.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.4c43266695a6f2b7b2bf.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.00d6092e308f6e31fd7a.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.f2baed1db5157d5aeba1.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.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.fbd27ab77e6e47de9931.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.2407cb357f385eb9ff9c.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.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="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-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8230.178147e4516bfa8b760d.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.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-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.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="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.48b876dfa499613f04d9.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="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.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="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.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="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.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="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="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="SuperHub-CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.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-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-gauge-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"> <link data-chunk="core-icons-book-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"> <link data-chunk="core-icons-inbox-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"> <link data-chunk="core-icons-unlock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-unlock-svg.d27591cc9e0be731e26d.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.00d6092e308f6e31fd7a.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.4c43266695a6f2b7b2bf.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/7188.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.7e7ac3b831d39ed8ef99.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.4c8c34bca506869e518a.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="Footer" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Footer.7ca87f1efe735da787ba.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.883d037c9b5898d42a5d.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.0ab6d6e327e2be33020a.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.59e02500db2c520b4509.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.b6e3c66bfa4e65097f5f.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.b2c21b39a87b5c42c152.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.0b0b64406047e2a3670a.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.7e7736cc7c5b0affc361.css"> <link data-chunk="SuperHub-CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.6f815c83f54659ae791f.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.b2c21b39a87b5c42c152.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:68px;height:40px;margin-top:0;background-image:url(https://files.readme.io/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.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-2025-03-27","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.322.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 no-sidebar hub-is-home"><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/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.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#63101613130c111723110c114d0c1104" 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 aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " 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 data-url="/v1/" value="1">v1</option><option selected="" data-url="#" 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#96e5e3e6e6f9e4e2d6e4f9e4b8f9e4f1" 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=/" target="_self" to="/login?redirect_uri=/">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/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-landing-page-2 Header-left-nav-icon10glJKFwewOv"></i>Home</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/" 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 ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div><div class="undefined container"><section class="LandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader"><h1 class="LandingPageHeader-title16RMwPkp2O2W">ROR Documentation</h1><div class="rm-Markdown markdown-body LandingPageHeader-text3zJOEVqnHdlf" data-testid="RDMD"><p>Comprehensive technical documentation for the Research Organization Registry (ROR), including ROR's metadata schema and REST API, plus implementation guides. Let's ROR!</p></div><div align="center" class="Flex Flex_row " justify="start" style="--flex-gap:var(--md)"><a class="Button Button_md LandingPageHeader-button_primaryLpo1zn3KXh20" href="/docs" target="_self"><i class="icon-guides"></i><span>Get Started</span></a></div></section></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav aria-label="Primary navigation" class="Header-leftADQdGVqx1wqU" role="navigation"><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 class="Truncate1OzxBYrNNfH3" style="--Truncate-max-width:150px">v2</span><i class="icon icon-chevron-down"></i></button></div><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " 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><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" 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="LandingWrap16kRMSdr5J8g rm-LandingPage" id="content"><div class="LandingBlock3PM-HyBxby3X LandingBlock_align=leftG1r7ROyW_AGB"><div class="rm-Markdown markdown-body" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="are-you-using-ror-v2-yet"></div><div class="heading-text"><div id="section-are-you-using-ror-v-2-yet" class="heading-anchor_backwardsCompatibility"></div>Are you using ROR v2 yet?</div><a aria-label="Skip link to Are you using ROR v2 yet?" class="heading-anchor-icon fa fa-anchor" href="#are-you-using-ror-v2-yet"></a></h2> <p>Version 2 of the ROR API, which includes version 2.1 of the ROR schema, was developed with extensive community input and is the current recommended, stable version. If you'd like help switching from ROR v1 to ROR v2, contact us at <a target="_self" href="/cdn-cgi/l/email-protection#ff8c8a8f8f908d8bbf8d908dd1908d98"><span class="__cf_email__" data-cfemail="fb888e8b8b94898fbb899489d594899c">[email protected]</span></a> with any questions.</p></div></div><div class="LandingBlock3PM-HyBxby3X LandingBlock-Docs1N0x68Z0Yw2J LandingBlock_align=leftG1r7ROyW_AGB"><div class="markdown-body"><h3>Getting Started with ROR</h3><ul><li><a href="/docs/basics">ROR basics</a></li><li><a href="/docs/identifier">Identifier pattern</a></li><li><a href="/docs/display">Logos and display guidelines</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/basics">View More… </a></li></ul></div><div class="markdown-body"><h3>ROR Metadata</h3><ul><li><a href="/docs/updates">Updates and curation</a></li><li><a href="/docs/data-structure">Data structure</a></li><li><a href="/docs/fields">Fields and sub-fields</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/updates">View More… </a></li></ul></div><div class="markdown-body"><h3>ROR REST API</h3><ul><li><a href="/docs/rest-api">About the ROR REST API</a></li><li><a href="/docs/api-single">Retrieve a single record</a></li><li><a href="/docs/api-list">Retrieve a list of records</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/rest-api">View More… </a></li></ul></div><div class="markdown-body"><h3>ROR Tools & Services</h3><ul><li><a href="/docs/data-dump">Data dump</a></li><li><a href="/docs/web-search">Web search</a></li><li><a href="/docs/openrefine-reconciler">OpenRefine reconciler</a></li></ul></div><div class="markdown-body"><h3>Collecting ROR IDs</h3><ul><li><a href="/docs/forms">Create ROR-powered forms</a></li><li><a href="/docs/matching">Match organization names to ROR IDs</a></li><li><a href="/docs/mapping">Map other organization IDs to ROR IDs</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/forms">View More… </a></li></ul></div><div class="markdown-body"><h3>Sharing ROR IDs</h3><ul><li><a href="/docs/crossref">Add ROR IDs to Crossref DOIs</a></li><li><a href="/docs/datacite">Add ROR IDs to DataCite DOIs</a></li><li><a href="/docs/jats">Add ROR IDs to JATS XML</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs/crossref">View More… </a></li></ul></div></div></main><footer aria-label="Status banner" class="Footer2U8XAPoGhlgO 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":"66072096d9631f0054e8c0eb","title":"Getting Started with ROR","slug":"getting-started","order":1,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:50:27.898Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"ROR basics","type":"basic","slug":"basics","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-basics","createdAt":"2021-06-22T21:59:37.805Z","category":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0ff","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":"66072096d9631f0054e8c0eb","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c100","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":"66072096d9631f0054e8c0eb","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fc","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fb","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c112","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":"66072096d9631f0054e8c0eb","createdAt":"2023-05-18T19:59:10.204Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f9","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0f0","title":"ROR Metadata","slug":"ror-metadata","order":3,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2024-03-09T14:02:43.834Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f3","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":"66072096d9631f0054e8c0f0","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f4","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":"metadata-policies","createdAt":"2021-06-22T22:01:04.607Z","category":"66072096d9631f0054e8c0f0","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c108","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":"66072096d9631f0054e8c0f0","createdAt":"2023-04-20T20:39:58.302Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c105","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":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-hierarchies-and-relationships","category":"66072096d9631f0054e8c0f0","createdAt":"2023-02-13T17:20:16.915Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Schema versions","icon":"","type":"basic","slug":"schema-versions","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"api-versioning-copy","parentDoc":null,"category":"66072096d9631f0054e8c0f0","createdAt":"2023-04-20T22:15:51.461Z","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10d","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":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-v20","parentDoc":null,"category":"66072096d9631f0054e8c0f0","createdAt":"2023-05-17T13:27:43.797Z","isBodyEmpty":false,"children":[]},{"_id":"675c4431512c430018f2144e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Schema 2.1","icon":"","type":"basic","slug":"schema-2-1","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-21","createdAt":"2024-12-13T14:26:00.000Z","category":"66072096d9631f0054e8c0f0","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ef","title":"ROR REST API","slug":"rest-api","order":5,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2023-10-27T20:32:47.999Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c106","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":"66072096d9631f0054e8c0ef","createdAt":"2023-02-27T10:04:38.511Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10e","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T16:53:35.628Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10f","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T16:55:44.021Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c111","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T23:36:13.204Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c110","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T23:35:27.796Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c103","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":"66072096d9631f0054e8c0ef","createdAt":"2023-01-25T21:51:49.092Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c107","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":"66072096d9631f0054e8c0ef","createdAt":"2023-03-15T18:44:15.278Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c104","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":"66072096d9631f0054e8c0ef","createdAt":"2023-01-25T21:52:57.629Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c109","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":"66072096d9631f0054e8c0ef","createdAt":"2023-04-20T20:59:28.209Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ed","title":"ROR Tools & Services","slug":"tools-services","order":6,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:51:52.183Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f5","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fd","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f6","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ee","title":"Collecting ROR IDs","slug":"mapping-and-matching","order":7,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2023-04-21T11:02:14.913Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c102","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":"66072096d9631f0054e8c0ee","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f8","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f7","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fa","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c115","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":"66072096d9631f0054e8c0ee","createdAt":"2024-03-06T21:49:56.732Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ec","title":"Sharing ROR IDs","slug":"implementation-how-to-guides","order":8,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:51:31.872Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c10b","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":"66072096d9631f0054e8c0ec","createdAt":"2023-04-20T22:17:32.825Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10c","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":"66072096d9631f0054e8c0ec","createdAt":"2023-04-20T22:18:05.994Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c101","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":"66072096d9631f0054e8c0ec","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fe","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":"66072096d9631f0054e8c0ec","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]}],"refs":[]},"apiBaseUrl":"/","baseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"Y2ZjY2JmN2Y5MGQwYzRjNTY0Njk0MjkzYTY2MThhZmM4MGM4YWE3MTFhYzI2OGM4NTEzNTMyMDZmMGQzOWJkMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjYwNzIwOTZkOTYzMWYwMDU0ZThjMTE4KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","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":"2"}},"changelogs":[{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":7,"publishPending":false,"updatedAt":"2024-12-17T16:46:34.889Z"},"title":"2024-12-12 Schema v2.1","slug":"2024-12-12-schema-v2-1","body":"# Schema v2.1: Tweaks to locations fields\n\nThe current ROR data structure was revised in April of 2024 and formalized into [schema v2.0](doc:schema-v2) as a JSON schema document. In schema v2.0, significant changes were made to fields that contained geographic information, including removing fields related to administrative subdivisions corresponding to units such as Canadian provinces, Japanese prefectures, and US states.\n\nWhile no issues were raised with these changes during the v2.0 feedback process, since the launch of this schema version, the need for additional location details to be included in our records was identified by users. As a result, a [proposal for schema v2.1](https://docs.google.com/document/d/11-bDfQWK038uoUBkL_CBZxP__xB6nBy0dVPH7tWxNnY), which adds country subdivision and continent fields, was circulated for public comment and finalized in Nov 2024. \n\nThis is a non-breaking change, and schema v2.1 changes have been incorporated directly into the v2 API with no version change needed in the API URL, per ROR's [schema and API versioning policy](https://ror.readme.io/v2/docs/api-versions).\n\n## Schema changes\n\nIn schema v2.1, the following fields have been added to the`geonames_details` sub-field within the`locations` field:\n\n- `continent_code` (required) 2-character code for the continent that the organization is located in, from the GeoNames record for the GeoNames ID in `locations.geonames_id`. All records have a value in the field.\n- `continent_name`(required) Name of the continent that the organization is located in, from the GeoNames record for the GeoNames ID in `locations.geonames_id`. All records have a value in the field.\n- `country_subdivision_code`2 or 3-character code for the highest-level country subdivision that the organization is located in, from the admin1Codes field of the GeoNames record for the GeoNames ID in `locations.geonames_id`. These are derived from [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\n- `country_subdivision_name`Name of the highest-level country subdivision that the organization is located in, from the admin1Codes field of the GeoNames record for the GeoNames ID in `locations.geonames_id`. These are derived from ISO-3166-2.\n\n**Continents:** GeoNames uses a 7-continent name and code convention, so continent name and code values are as follows: Africa (AF), Antarctica (AN), Asia (AS), Europe (EU), North America (NA), Oceania (OC), and South America (SA).\n\n**Country subdivisions: ** The type of subdivision represented by the `country_subdivision_code` and `country_subdivision_name` fields varies depending on the location identified by the Geonames ID in the `locations.geonames_id` field. For the United States, for example, it represents states. Some organizations are not located within a country subdivision (ex, research stations in Antarctica), so not all records have values in these fields. See [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) for a list of country subdivisions by country.\n\nAlso, in schema 1.0, `Funder` has been added as an allowed value in the `types` field. This is because `Funder` was initially added as a type in v2 only, and when new records are created in v2 that only have a type of `Funder` the corresponding v1 record has no values in `types`. NOTE: Most v2 records with `Funder` in `types` have multiple values in `types`, so only a very small number of records had no types in v1.\n\n## API changes\n\n### v2 API\n\n- The above new locations fields now appear in each record in when using the v2 API `https://api.ror.org/v2/organizations`.\n- `continents` now appears in the `meta` section of list results in the v2 API, ex`https://api.ror.org/v2/organizations`.\n- New filters for continent name and code are now available in the v2 API, ex `https://api.ror.org/v2/organizations?filter=locations.geonames_details.continent_name:Asia` and `https://api.ror.org/v2/organizations?filter=locations.geonames_details.continent_code:AS`.\n- Data in `locations` fields in all records was updated using the latest values from GeoNames. \n\n### v1 API\n\n- `Funder` now appears in the `types` field of v1 records that have `funder` in `types` in their corresponding v2 record.\n- `Funder` is now an allowed value for the `types` filter, ex `https://api.ror.org/organizations?filter=types:Funder`.\n- Data in `addresses` fields in all records was updated using the latest values from GeoNames. \n- NOTE: Beginning with the April 2024 launch of v2, ROR metadata is curated only in v2 and then crosswalked / copied to v1 records. As a result, when records are added or updated, v1 fields that do not have equivalents in v2 are not populated. This includes many `addresses` sub-fields in v1 records. All records have been updated for v2.1 in [release 1.58](https://github.com/ror-community/ror-updates/releases/tag/v1.58), and therefore deprecated sub-fields in `addresses` are now null in all v1 records. \n\n## Data dump changes\n\n- New fields listed above are included in the JSON and CSV v2 data dump files.\n- No changes have been made to filenames.\n- NOTE: Beginning with the April 2024 launch of v2, ROR metadata is curated only in v2 and then crosswalked / copied to v1 records. As a result, when records are added or updated, v1 fields that do not have equivalents in v2 are not populated. This includes many `addresses` sub-fields in v1 records. All records have been updated for v2.1 in [release 1.58](https://github.com/ror-community/ror-updates/releases/tag/v1.58), and therefore deprecated sub-fields in `addresses` are now null in all v1 records.\n\n## Search UI changes\n\n- No changes have been made to the search UI at <https://ror.org/search>.","searchContents":"","type":"improved","hidden":false,"revision":29,"_id":"675b84f804346d00128b94a2","user":{"name":"Liz Krznarich","_id":"6058e462f15349003a4afdfe"},"project":"6058e47681775f002de04832","createdAt":"2024-12-13T00:51:00.000Z","updatedAt":"2024-12-17T16:46:34.290Z","lastUpdatedHash":"51f8760606bfae1a852d37d5b2d7c86657ee6997","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":6,"publishPending":false,"updatedAt":"2024-04-11T21:36:08.538Z"},"title":"2024-04-11 Schema & API v2","slug":"2024-04-11-schema-api-v2","body":"# Introducing v2\n\nAfter over a year planning and many rounds of community input, we are thrilled to release ROR's first major schema and API update (version 2.0)! Per [ROR's versioning policy](https://ror.readme.io/docs/schema-versions), v1 will continue to remain available in the API and data dump through at least April 2025, and will likely be available for 6-12 months beyond that date.\n\nBelow is a list of changes deployed to the schema, API, data dump and search user interface. For complete documentation in v2, see <https://ror.readme.io/v2/docs> . \n\n## Schema changes\n\nThe following changes have been implemented in schema v2.0, based on input received through multiple rounds of community feedback ([see Schema v2 feedback documents](https://ror.readme.io/v2/docs/feedback-docs#ror-schema-v20)). The previous schema (which was originally unversioned but is now referred to as v1.0) remains unchanged. For additional details and examples see [schema v2 documentation](https://ror.readme.io/v2/docs/schema-v2) and the [v2.0 JSON schema document](https://github.com/ror-community/ror-schema/blob/master/ror_schema_v2_0.json)\n\n- **Name information** previously in `name`, `acronyms`, `aliases`, and `labels` fields is now contained in 1 parent field, `names` with subfields `lang`, `value` and `types`. **Please note that the `lang` subfield has only been populated for names with `labels` in their `types`. ** The curation team will be working on adding language codes to other names types over the coming months.\n- **Location information** previously in `addresses` field is now in `locations` field with subfields `geonames_id` and `geoneames_details`. Many fields containing very granular information derived from Geonames have been removed, as this information is avilable directly from [Geonames](https://www.geonames.org/). Additionally, country code and name information previously in the `country` field has been moved to `locations.geonames_details.country_code` and `locations.geonames_details.country_name`\n- **Website/domain information** previously in `links` and `wikipedia_url` have been combined into a 1 parent field `links` with subfields `type` and `value`. The `ip_addresses` field has been removed (it was not populated by GRID for any records). The `domains` field has been added, however, **please note that this field has not yet been populated**. The curation team will be working on this over the coming months. \n- **External identifiers information** has been restructured within the existing `external_ids` field. Each item in external_ids now has subfields `type`, `all` and `preferred`. The data type for `all` is a list for each `external_ids` item, whereas it was previously a string for GRID IDs and a list for other ID types.\n- **Administrative information** was not included previously. A new parent field `admin` has been added, which contains subfields `created` and `last_modified`. Each of those subfields contains additional subfields `date` and `schema_version`. Created date for each record was extracted from previous GRID _and_ ROR releases. Last modified dates were extracted from ROR releases only, as, at a minimum, each record in ROR has been modified by the ROR curation team to add a ROR ID in the `id` field.\n- **Controlled lists** previously had variations in casing. For example, values in the `types` and `relationships.type` fields began with an uppercase character, while values in `status` were lowercase and external ID types contained a variety of casings. In v2, allowed values in controlled lists are consistently lowercase, with the exception of country codes derived from [ISO-3166](https://www.iso.org/iso-3166-country-codes.html), which are uppercase per the standard.\n\n### Important notes about v2 record data\n\nThere are several new fields/subfields in v2, and the dataset used in the beta has not been fully updated with values in all new fields/subfields. In particular:\n\n- **Created/last modified dates** _HAVE_ been added to all records, using actual dates from GRID and ROR data releases.\n- **Domains** _HAVE NOT_ been added. This field is currently an empty list for all records. This field requires careful curation to ensure accuracy. We plan to add data to this field over the coming months.\n- **Language codes** for items in the names fields are only included for names inherited from the labels field in the current schema. Language codes _HAVE NOT_ been added for names inherited from the name and aliases fields in the current schema. We plan to add language codes over the coming months, with the goal of ensuring that (minimally) each name with “ror_display” in its types has a language code.\n\n## API changes\n\n- API now supports versioning, with `v1` or `v2` supplied in the path portion of a request, ex `https://api.ror.org/v2/organizations`. The same data is available in both versions; responses are formatted according to the version in the request path.\n- If no version is supplied, a default version is used. `v1` will remain the default through April 2025.\n- For `v2`, in addition to following the v2 schema, values in fields that contain multiple values are sorted by Unicode value, which is alphabetical for characters in the Basic Latin set.\n- A new organization type `funder` is available when [filtering results based on organization type](https://ror.readme.io/v2/docs/api-filtering#filter-by-organization-type)\n- Because v2 contains different fields from v1, fields available to search using the advanced query functionality `https://api.ror.org/v2/organizations?query.advanced=` are different from v1. See [v2 advanced query documentation](https://ror.readme.io/v2/docs/api-advanced-query). A notable addition is the ability to search by created or last modified date!\n- All other API functionality is identical to v2; records in responses are simply returned in v2 format. Records added or last updated in v1 are mapped to v2 and created/last modified are populated based on changelogs from previous data dump releases. \n- v1 API functionality is unchanged. Records added or last updated in v2 are mapped to v1 and contain empty or null values for fields that don't exist in v2.\n\n## Data dump changes\n\nROR data dumps continue to be available in Zenodo at <https://doi.org/10.5281/zenodo.6347574>. Beginning with release v1.45 on 11 April 2024, the following changes have been made to the data dump:\n\n- Data releases contain JSON and CSV files formatted according to both schema v1 and schema v2. This means that there are now 4 files in each data release instead of 2.\n- v2 files have `_schema_v2` appended to the end of the filename, ex `v1.45-2024-04-11-ror-data_schema_v2.json` .\n- In order to maintain compatibility with previous releases, v1 files have no version information in the filename, ex `v1.45-2024-04-11-ror-data.json`\n- For both versions, the CSV file contains a subset of fields from the JSON file, some of which have been flattened for easier parsing. As ROR records and the ROR schema are maintained in JSON, CSVs are for convenience only. JSON remains the format of record.\n- In v2 dump files, values in fields that contain multiple values are sorted by Unicode value, which is alphabetical for characters in the Basic Latin set.\n- In v2 dump files, records added or last updated in v1 are mapped to v2 and created/last modified are populated based on changelogs from previous data dump releases.\n- In v1 dump files, records added or last updated in v2 are mapped to v1 and contain empty or null values for fields that don't exist in v2.\n\nRelease versioning has not been changed. The ROR API default version remains v1 and will be changed to v2 in April 2025. To align with the API, the data dump major version will remain at 1 until the API default version is changed to v2. At that time, the data dump major version will be incremented to 2 as noted in metadata for <https://doi.org/10.5281/zenodo.6347574>.\n\n## Search UI changes\n\n- The [ROR search UI](https://ror.org/search) nows uses API v2\n- Sub-headings have been added to the Other names section to identify name types (acronyms, aliases, labels)\n- A link to the JSON view is included at the bottom of each record\n\n<br>","searchContents":"","type":"","hidden":false,"revision":13,"_id":"660dc7e1cf1a5f0017adbdd6","user":{"name":"Liz Krznarich","_id":"6058e462f15349003a4afdfe"},"project":"6058e47681775f002de04832","createdAt":"2024-04-03T21:19:29.919Z","updatedAt":"2024-04-11T21:36:08.344Z","lastUpdatedHash":"6c214177d1fc4bc5b8bc3c2eb1c9843bd69678eb","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2024-03-29T20:12:10.542Z"},"title":"2023-04-25 API infrastructure improvements","slug":"2023-04-25-api-infrastructure-improvements","body":"ROR API usage has increased dramatically over the past 3 years, from ~1 million requests per month to over 17 million. We made some tweaks along the way to keep it up and running, but we knew that a more significant overhaul was needed to put ROR in a good position to handle further API traffic increases. This is why [API infrastructure updates and scaling](https://github.com/ror-community/ror-roadmap/issues/124) were included as a major project on our [2023 Roadmap](https://github.com/ror-community/ror-roadmap/projects/3).\n\nAs of 25 Apr, we have completed the following updates and rolled them out to production:\n\n- Updated Elasticsearch software from 6.3 to 7.10 (the latest version supported by AWS; in the future, we will migrate to AWS OpenSearch)\n- Added nodes in the AWS Elasticsearch cluster, which are now distributed across 2 availability zones\n- Re-configured Elasticsearch sharding\n- Added more ROR API application containers, with auto-scaling as needed\n\nWith these changes, API users should see speedier performance for all API requests, particularly at peak traffic times. That said, updating to a new major version of Elasticsearch involved significant changes to underlying code. If you notice any issues, please let us know in the [ROR Tech Forum](https://groups.google.com/a/ror.org/g/ror-tech) or at [support@ror.org](mailto:support@ror.org) .","searchContents":"","type":"improved","hidden":false,"revision":4,"_id":"6447efb08ec21a0065f5b2b6","user":{"name":"Liz Krznarich","_id":"6058e462f15349003a4afdfe"},"project":"6058e47681775f002de04832","createdAt":"2023-04-25T15:20:16.966Z","updatedAt":"2024-03-29T20:12:10.542Z","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2024-03-29T20:12:09.689Z"},"title":"2023-03-16 CSV data dump","slug":"2023-03-16-csv-data-dump","body":"By popular demand, starting with [today's data release (v1.21)](https://doi.org/10.5281/zenodo.7742581), the data dump includes a CSV version of the ROR data file in addition to the canonical JSON file. \n\nThe data dump zip therefore now contains two files instead of one. If your code currently expects only one file, you will need to update it accordingly. \n\nThe CSV contains a subset of fields from the JSON file, some of which have been flattened for easier parsing. The JSON file remains the version of record.","searchContents":"","type":"","hidden":false,"revision":3,"_id":"64138decbd9fd50026f607c9","user":{"name":"Liz Krznarich","_id":"6058e462f15349003a4afdfe"},"project":"6058e47681775f002de04832","createdAt":"2023-03-16T21:45:16.560Z","updatedAt":"2024-03-29T20:12:09.689Z","__v":0},{"metadata":{"image":[],"title":"","description":"","keywords":""},"mdx":{"altBody":"","status":"rdmd"},"algolia":{"recordCount":19,"publishPending":false,"updatedAt":"2024-03-29T20:12:09.534Z"},"title":"2022-12-01 Organization status changes","slug":"2022-12-01-organization-status-changes","body":"After a 6-month period of planning, community input and implementation, we've released changes to the API, UI and data dump in order to support cases where an organization has ceased to operate, merged with another organization, was added to ROR in error. [Read the rest of this post for complete details!](https://ror.readme.io/changelog/2022-12-01-organization-status-changes)\n\nThese changes were developed in consultation with the ROR community; a [draft proposal](https://docs.google.com/document/d/1CK3-Q9T1jeZ-CDvsAZoeg5Ng7ljzVau6iE_NzN8Kw88) was open for public comment 15 Jun-15 Jul 2022 and a [\"final\" proposal](https://docs.google.com/document/d/13zFXGOuaEcgJlXz6gw9IOZUaP_khZ0d5r0nODFDyFfE) was shared in Aug 2022. The specifications for these changes were based on the final proposal.\n\n**These changes are non-breaking and are compatible with the current ROR schema.**\n\n## What changed?\n\n### Record schema\n\nNew values allowed in [status field](https://github.com/ror-community/ror-schema/blob/master/ror_schema.json#L441):\n\n- **inactive**: Organization no longer operates as described in its ROR record. For example, it has split into multiple organizations, merged with 1 or more organizations or has otherwise ceased to operate. \n- **withdrawn**: Organization whose ROR record was created in error. For example, the organization already existed in ROR under a different name or the organization is not in scope for ROR and should not have been added.\n\nNew values allowed in [relationships.type field](https://github.com/ror-community/ror-schema/blob/master/ror_schema.json#L398): \n\n- **Successor**: An active organization that continues the work of a given organization after it has become inactive\n- **Predecessor**: An inactive organization that previously carried out the work of a given organization \n\n_Note: Unlike Parent/Child relationships in ROR, Successor/Predecessor relationships are not always added in pairs. In other works, each Successor relationship does not necessarily have a corresponding Predecessor relationship._\n\nSee [ROR data structure](https://ror.readme.io/docs/data-structure#status) for more information about status and relationships.\n\n### API\n\n- Returns active records only by default; use parameter `?all_status` to return all records. ?`all_status=true` and `?all_status=false` are also supported. This is true for listing organizations using `/organizations`, querying using either `?query` or `?query.advanced` and matching affiliation strings using `?affiliation`.\n- When retrieving a record by its ROR ID, the record will be returned regardless of its status and whether `?all_status` or `?filter` parameters are present.\n- New filter parameter value `status` is available, ex `?filter=status:inactive`. If `?filter=status:` is used, `?all_status` parameter is ignored.\n- New status and relationship type values are available in fielded searches using query.advanced, ex `?query.advanced=status:inactive`. If a fielded search includes status field, `?all_status` parameter is ignored.\n- New aggregation `statuses` in meta section of responses\n\n### Data dump\n\n- Data dump files include all records with all statuses. No changes, except that some records contain the new values above in status and relationships.type fields. The first data dump file with new status and relationship type values is <https://doi.org/10.5281/zenodo.7387951>.\n\n### Search UI\n\n- List views return active records only by default\n- Results can be filtered by status\n- Query for a specific ROR ID will return matching result regardless of status\n\n### Data release v1.15\n\nAdditionally, we’ve just published data release v1.15, which is the first data release that includes records with the new status and relationship type values above. Release v1.15 includes open IDs and metadata for 103,047 organizations (102,935 active, 103 inactive, 9 withdrawn). Both the API and data dump have been updated. The latest data dump is available at <https://doi.org/10.5281/zenodo.7387951>. This release includes updated records listed in the [v1.15 data release notes](https://github.com/ror-community/ror-updates/releases/tag/v1.15).\n\n## Example records\n\n### Inactive\n\n- [https://ror.org/02h60r346](https://ror.org/03ybx0x41) (no successor)\n- <https://ror.org/000d53575> (with successor)\n\n### Withdrawn\n\n- <https://ror.org/03ybx0x41> (with successor)\n\n## Example API requests\n\n### List active organizations only (no change from existing request)\n\n```curl\ncurl https://api.ror.org/organizations\n```\n\nNote: Request above returns same results as `?filter=status:active` and `?query.advanced=status:active`\n\n### List organizations with any status\n\n```curl\ncurl https://api.ror.org/organizations?all_status\n```\n\n### Query active organizations only (no change from existing request)\n\n```curl\ncurl https://api.ror.org/organizations?query=university\n```\n\n### Query organizations with any status\n\n```curl\ncurl https://api.ror.org/organizations?query=university&all_status\n```\n\n### Match affiliation strings to active organizations only (no change from existing request)\n\n```curl\ncurl https://api.ror.org/organizations?affiliation=Laboratory+of+Hydrology+and+Geochemistry\n```\n\n### Match affiliation strings to organizations with any status\n\n```curl\ncurl https://api.ror.org/organizations?affiliation=Laboratory+of+Hydrology+and+Geochemistry?all_status\n```\n\n### Filter by status\n\n```curl\ncurl https://api.ror.org/organizations?filter=status:inactive\n```\n\nCan be repeated, for example to retrieve organizations with a status of inactive OR withdrawn\n\n```curl\ncurl https://api.ror.org/organizations?filter=status:inactive,status:withdrawn\n```\n\n Can be combined with other filters (see [list of available filters and values](https://ror.readme.io/docs/rest-api#filtering))\n\n```curl\ncurl https://api.ror.org/organizations?filter=status:inactive,status:withdrawn,country.country_code:us\n```\n\nCan be combined with ?query or ?query.advanced searches. \n_Note: Filters cannot be used with ?affiliation searches._\n\n```curl\ncurl 'https://api.ror.org/organizations?query=International+Union&filter=status:inactive,status:withdrawn'\n```\n\n### Use new status/relationship type values in fielded searches\n\n_Note: if a fielded search includes status field, ?all_status is not needed in order to return records with statuses other than active._ \n\n```curl\ncurl 'https://api.ror.org/organizations?query.advanced=status:inactive+AND+addresses.city:Yerevan'\n```\n\n```curl\ncurl 'https://api.ror.org/organizations?query.advanced=status:inactive+AND+relationships.type:Successor'\n```\n\nThe [API documentation](https://ror.readme.io/docs/rest-api#record-status) has also been updated to reflect the above changes.","searchContents":"","type":"improved","hidden":false,"revision":28,"_id":"637e2bbce25ace00244d06c7","pendingAlgoliaPublish":false,"createdAt":"2022-11-23T14:18:36.571Z","user":{"name":"Liz Krznarich","_id":"6058e462f15349003a4afdfe"},"project":"6058e47681775f002de04832","updatedAt":"2024-03-29T20:12:09.534Z","__v":0,"lastUpdatedHash":"ea65572db468c1aa67d17d9c62c072576085fafa"}],"discuss":[],"docsCategories":[{"_id":"66072096d9631f0054e8c0eb","title":"Getting Started with ROR","slug":"getting-started","order":1,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:50:27.898Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"ROR basics","type":"basic","slug":"basics","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-basics","createdAt":"2021-06-22T21:59:37.805Z","category":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0ff","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":"66072096d9631f0054e8c0eb","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c100","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":"66072096d9631f0054e8c0eb","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fc","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fb","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c112","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":"66072096d9631f0054e8c0eb","createdAt":"2023-05-18T19:59:10.204Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f9","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":"66072096d9631f0054e8c0eb","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0f0","title":"ROR Metadata","slug":"ror-metadata","order":3,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2024-03-09T14:02:43.834Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f3","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":"66072096d9631f0054e8c0f0","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f4","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":"metadata-policies","createdAt":"2021-06-22T22:01:04.607Z","category":"66072096d9631f0054e8c0f0","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c108","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":"66072096d9631f0054e8c0f0","createdAt":"2023-04-20T20:39:58.302Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c105","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":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-hierarchies-and-relationships","category":"66072096d9631f0054e8c0f0","createdAt":"2023-02-13T17:20:16.915Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Schema versions","icon":"","type":"basic","slug":"schema-versions","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"api-versioning-copy","parentDoc":null,"category":"66072096d9631f0054e8c0f0","createdAt":"2023-04-20T22:15:51.461Z","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10d","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":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-v20","parentDoc":null,"category":"66072096d9631f0054e8c0f0","createdAt":"2023-05-17T13:27:43.797Z","isBodyEmpty":false,"children":[]},{"_id":"675c4431512c430018f2144e","mdx":{},"api":{"method":"get","url":"","auth":"required","params":[]},"title":"Schema 2.1","icon":"","type":"basic","slug":"schema-2-1","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-21","createdAt":"2024-12-13T14:26:00.000Z","category":"66072096d9631f0054e8c0f0","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ef","title":"ROR REST API","slug":"rest-api","order":5,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2023-10-27T20:32:47.999Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c106","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":"66072096d9631f0054e8c0ef","createdAt":"2023-02-27T10:04:38.511Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10e","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T16:53:35.628Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10f","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T16:55:44.021Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c111","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T23:36:13.204Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c110","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":"66072096d9631f0054e8c0ef","createdAt":"2023-05-17T23:35:27.796Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c103","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":"66072096d9631f0054e8c0ef","createdAt":"2023-01-25T21:51:49.092Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c107","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":"66072096d9631f0054e8c0ef","createdAt":"2023-03-15T18:44:15.278Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c104","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":"66072096d9631f0054e8c0ef","createdAt":"2023-01-25T21:52:57.629Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c109","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":"66072096d9631f0054e8c0ef","createdAt":"2023-04-20T20:59:28.209Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ed","title":"ROR Tools & Services","slug":"tools-services","order":6,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:51:52.183Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c0f5","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fd","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f6","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":"66072096d9631f0054e8c0ed","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ee","title":"Collecting ROR IDs","slug":"mapping-and-matching","order":7,"reference":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2023-04-21T11:02:14.913Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c102","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":"66072096d9631f0054e8c0ee","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f8","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0f7","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fa","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":"66072096d9631f0054e8c0ee","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c115","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":"66072096d9631f0054e8c0ee","createdAt":"2024-03-06T21:49:56.732Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"66072096d9631f0054e8c0ec","title":"Sharing ROR IDs","slug":"implementation-how-to-guides","order":8,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"66072096d9631f0054e8c118","createdAt":"2021-06-22T21:51:31.872Z","__v":0,"pages":[{"_id":"66072096d9631f0054e8c10b","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":"66072096d9631f0054e8c0ec","createdAt":"2023-04-20T22:17:32.825Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c10c","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":"66072096d9631f0054e8c0ec","createdAt":"2023-04-20T22:18:05.994Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c101","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":"66072096d9631f0054e8c0ec","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66072096d9631f0054e8c0fe","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":"66072096d9631f0054e8c0ec","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]}],"refCategories":[],"meta":{"title":"ROR","type":"home"},"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-2025-03-27","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.322.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/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png","4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png",136,80,"#242c24","https://files.readme.io/044ba45b93ac5dedcb918fd8280e53ec0243dd1b04b9edaed5ba61d09283f7b7-ror-logo-2600px.png","6762cc61aa21d600184034d9"],"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,"apiDesigner":false,"hideEnforceSSO":false,"superHubMigrationSelfServeFlow":true,"gitSidebar":true,"localLLM":false,"superHubGlobalCustomBlocks":false,"superHubManageVersions":false,"childManagedBidi":false},"fullBaseUrl":"https://ror.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"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,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"Are you using ROR v2 yet?","text":"Version 2 of the ROR API, which includes version 2.1 of the ROR schema, was developed with extensive community input and is the current recommended, stable version. If you'd like help switching from ROR v1 to ROR v2, contact us at support@ror.org with any questions."},{"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":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"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":1,"updatedAt":"2025-03-13T18:52:27.555Z","forked_from":"6058e47681775f002de04837","apiRegistries":[],"pdfStatus":""},"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=/"}],"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":false,"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":3,"updatedAt":"2025-03-13T18:52:27.578Z","apiRegistries":[],"pdfStatus":""},{"_id":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"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":1,"updatedAt":"2025-03-13T18:52:27.555Z","forked_from":"6058e47681775f002de04837","apiRegistries":[],"pdfStatus":""}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"2"},"description":"Technical documentation for ROR, the Research Organization Registry, a global, community-led registry of open persistent identifiers for research organizations.","glossary":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"homepage_url":"https://ror.org","id":"6058e47681775f002de04832","name":"ROR","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"ror","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"disabled"},"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},"refactored":{"status":"disabled","migrated":"unknown"},"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":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"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":null}},"main":{"uri":"/images/6762cc61aa21d600184034d9","url":"https://files.readme.io/4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png","name":"4680beec6938bde00138451225326037ace6f6e8011c88b92e902c051dfb922e-small-ror-logo-2600px.png","width":136,"height":80,"color":"#242c24","links":{"original_url":"https://files.readme.io/044ba45b93ac5dedcb918fd8280e53ec0243dd1b04b9edaed5ba61d09283f7b7-ror-logo-2600px.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"}}}},"git":{"connection":{"repository":{},"status":"inactive"}}}},"version":{"_id":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"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":1,"updatedAt":"2025-03-13T18:52:27.555Z","forked_from":"6058e47681775f002de04837","apiRegistries":[],"pdfStatus":""}},"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/","version":{"_id":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"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":1,"updatedAt":"2025-03-13T18:52:27.555Z","forked_from":"6058e47681775f002de04837","apiRegistries":[],"pdfStatus":""}}"></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">[6601,1126,6563,9772,4904,7449,7372,187,734,954,1167,2395,9321,3073,1008,7188,5753,2852,2249,3901,7783,1456,4935,3221,7327,1666,5798,4287,5948,4201,8230,1313,1343,6060,3906,3787,1202,1936,7717,5359,3307,9575,7356,2144,9141,3859,5408,2637,2402,1731,1080,9852,8684,2447,2578,8063,4467,3556,7031,6262,4793,2616,3412,678,7779,3626,7289,1813,8899]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-PageNotFound","Footer","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","routes-Landing","core-icons-alert-circle-svg","routes-Doc","routes-SuperHub-Routes","core-icons-arrow-right-svg","RMDX","routes-Changelog","Post","core-icons-chevron-down-svg","routes-Discuss","Page","List","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","CustomPage","core-icons-eye-off-svg","core-icons-arrow-up-right-svg","routes-Tutorials","core-icons-key-svg","routes-CustomPage","core-icons-message-circle-svg","SuperHub-CustomPage","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","core-icons-webhook-svg","core-icons-gauge-circle-svg","core-graphics-json-svg","core-icons-book-svg","core-icons-inbox-svg","core-icons-unlock-svg","New"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.f2baed1db5157d5aeba1.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6601.cef2fa12a9b5e2b9df03.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1126.9d43ffa1039df16a8271.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6563.fbd3d15eee3b5e94f665.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.89a3e895d3051e33cd73.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.1067704c85da57778e22.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.fbd27ab77e6e47de9931.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/187.23cea47109f7f88417f6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.2949e3d7010fa5c21ffd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/954.53ce7f86793664155f78.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1167.a6c63c62c8690225da20.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.771431a607874f268eb2.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9321.7bab74274e71e18bb347.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3073.ef6aff2d0ae6023765f1.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.2407cb357f385eb9ff9c.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.f444adf64944d115c52b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.72c5d7402efc1cfa5881.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.3432b44653552d31effc.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/2249.08687f22f6d6de29577d.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3901.9a23139e8c32bd6a1186.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.54e7cbd61e710313e1e0.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.415a3e3f42422a2546f5.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="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-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.e4a4a4dbb41ce1f8c60f.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.732d39065ba473dca3be.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/5948.a51402657e2eb40ab43b.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/4201.9726bbf672400e046cc2.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/8230.178147e4516bfa8b760d.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.a6b1c6bee69d46fd161f.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-Landing" src="https://cdn.readme.io/public/hub/web/3906.b84848dda7e7f59abf47.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.43a15229736801911d5a.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="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.ab23d1cf8ea817ed6084.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7717.c3f46aef4dac129abcfb.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/5359.fb0c48929b1827a8a2b2.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.48b876dfa499613f04d9.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="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.6966846032c03969e44f.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.05be16260f5ffacc35a3.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.0ba0ba3778e78d8254e8.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="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.9a682a77c9083927aeaf.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.d47bf77a75f266a70e80.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.6d18db72aa3774dd903a.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.b1dd4485529aa4a7aa11.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.fcff689c44b953a512d6.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="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.29543915f3e70fa960d7.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> <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="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c83f9bb228d60f5f7f6b.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="SuperHub-CustomPage" src="https://cdn.readme.io/public/hub/web/SuperHub-CustomPage.edef7b501475b233c5a2.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-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="core-icons-gauge-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-gauge-circle-svg.fff25782546fef314a09.js"></script> <script async data-chunk="core-icons-book-svg" src="https://cdn.readme.io/public/hub/web/core-icons-book-svg.556c5a2abddd44b2284c.js"></script> <script async data-chunk="core-icons-inbox-svg" src="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"></script> <script async data-chunk="core-icons-unlock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-unlock-svg.d27591cc9e0be731e26d.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.19db37c76f3b9d17353d.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"Y2ZjY2JmN2Y5MGQwYzRjNTY0Njk0MjkzYTY2MThhZmM4MGM4YWE3MTFhYzI2OGM4NTEzNTMyMDZmMGQzOWJkMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjYwNzIwOTZkOTYzMWYwMDU0ZThjMTE4KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:6058e47681775f002de04832),(version:none,version:66072096d9631f0054e8c118),(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>

CINXE.COM

ROR