About the ROR REST API

<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1740772393201"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.294.0"><meta name="readme-subdomain" content="ror"><meta name="readme-version" content="1"><title>About the ROR REST API</title><meta name="description" content="Recent changes to the ROR REST API include default return of only active records, new query parameter for all statuses, and updated values in status and relationships. Users can access the API without registration, but there is a rate limit of 2000 requests in a 5-minute period. Join the ROR Technic..."><meta property="og:title" content="About the ROR REST API"><meta property="og:description" content="Recent changes to the ROR REST API include default return of only active records, new query parameter for all statuses, and updated values in status and relationships. Users can access the API without registration, but there is a rate limit of 2000 requests in a 5-minute period. Join the ROR Technic..."><meta property="og:site_name" content="ROR"><meta name="twitter:title" content="About the ROR REST API"><meta name="twitter:description" content="Recent changes to the ROR REST API include default return of only active records, new query parameter for all statuses, and updated values in status and relationships. Users can access the API without registration, but there is a rate limit of 2000 requests in a 5-minute period. Join the ROR Technic..."><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/docs/rest-api"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1740772393201"></script><link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.46c7cd50bf55e4372327.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.571e99fd5e02a59c06dd.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.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.7f77cac277dcc8a3d6b8.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.60a8dcec37a13b0b71c5.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.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.074b2cb2cc57c5a5979d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.f1a708954fcb2985d9f6.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.ef84cc15c1ff3d327657.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.15432b2b5da9013070bb.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.5291198bd71a134466e9.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/3622.30b9cb2443fabb238262.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.dcd45762ee393f583fea.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.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.4f5a59d2f86c6ece493b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/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/6903.75b9333e2c99d6924d0e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.93b03fc4eb8efabb08a7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8161.c06bb55544d4d5ece838.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1008.4c339ef2e2b87bbd1d0b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7188.9cd5fd7fe0a05ab94dea.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5753.887d4d8ae5466a3f3b2a.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.6d52d3d479e7e6844ace.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.2497238876f4f363107c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.85a768f818d97858fce7.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.852328ff472332820e4a.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.43a913423ff21c406134.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.fe60df69c20b2ce54513.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.f81f304a0f9e9f73d47e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.638ac41f3269eb8fe633.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/8230.128cfdd53c803eea12b2.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.f1f59d6d6f3fec6c0a4e.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-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.1ea18c7d8e69fc7252af.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-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-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/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.5cae0557d05c869c77bf.js"> <link data-chunk="RMDX" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/RMDX.aefe00bd92fd4e78ab65.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.80a45bec48d0ae892ab7.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.34fb79ca63e7ed2617d0.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.85c89705122f7bc8f4f3.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="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="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-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-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.dae2f8e80d2d75f106bd.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.4e99fc9641c6a023c75a.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="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.6e1931c1363cea798412.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.a16df6acd7d10a15e9da.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-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c491da97152573555d9f.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="core-icons-chevron-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"> <link data-chunk="core-icons-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"> <link data-chunk="core-icons-folder-plus-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"> <link data-chunk="core-icons-file-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-file-svg.24d3e20044ef331cf0d2.js"> <link data-chunk="core-icons-eye-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.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="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.15432b2b5da9013070bb.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.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.f1a708954fcb2985d9f6.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.074b2cb2cc57c5a5979d.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.f7ce97dc8d07fa3e6aaa.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.7f77cac277dcc8a3d6b8.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.23606d783f007047768a.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.571e99fd5e02a59c06dd.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.46c7cd50bf55e4372327.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.c978ddef3555c7447f00.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-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.294.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#44A28F;--color-primary-inverse:#fff;--color-primary-alt:#227866;--color-primary-darken-10:#357e6f;--color-primary-darken-20:#265a50;--color-primary-alpha-25:rgba(68, 162, 143, 0.25);--color-link-primary:#44A28F;--color-link-primary-darken-5:#3c907f;--color-link-primary-darken-10:#357e6f;--color-link-primary-darken-20:#265a50;--color-link-primary-alpha-50:rgba(68, 162, 143, 0.5);--color-link-primary-alpha-25:rgba(68, 162, 143, 0.25);--color-link-background:rgba(68, 162, 143, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="https://ror.org" target="_self"><img alt="ROR" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/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#cab9bfbabaa5b8be8ab8a5b8e4a5b8ad" target="_self" to="mailto:support@ror.org">Contact support</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option selected="" data-url="#" value="1">v1</option><option data-url="/v2/docs" value="2">v2</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://github.com/ror-community/ror-roadmap/issues/new/choose" rel="noopener" target="_blank" to="https://github.com/ror-community/ror-roadmap/issues/new/choose">Report a bug or request a feature</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/cdn-cgi/l/email-protection#4e3d3b3e3e213c3a0e3c213c60213c29" target="_self" to="mailto:support@ror.org">Contact support</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/docs/rest-api" target="_self" to="/login?redirect_uri=/docs/rest-api">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-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/docs/rest-api" 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><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span>v1</span><i class="icon icon-chevron-down"></i></button></div><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><i class="icon-changelog"></i><span>Changelog</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">About the ROR REST API</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘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="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting Started with ROR</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/basics"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">ROR basics</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/identifier"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Identifier pattern</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/display"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Logos and display guidelines</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/integrations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">See who uses ROR</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/get-involved"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Get involved</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/feedback-docs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Community feedback documents</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/contact"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Contact us</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">ROR Metadata</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/updates"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Updates and curation</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/data-structure"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data structure</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/fields"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Fields and sub-fields</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/relationships"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Relationships and hierarchies</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/schema-versions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Schema versions</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/schema-v2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Schema 2.0</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/schema-2-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Schema 2.1</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">ROR REST API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/rest-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">About the ROR REST API</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-single"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Retrieve a single record</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-list"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Retrieve a list of records</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-filtering"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Filtering</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-paging"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Paging</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-query"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Query parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-advanced-query"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Advanced query parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-affiliation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Affiliation parameter</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/api-versions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">API versions</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">ROR Tools & Services</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/data-dump"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Data dump</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/web-search"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Web search</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/openrefine-reconciler"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">OpenRefine reconciler</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Collecting ROR IDs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/forms"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Create ROR-powered forms</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/matching"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Match organization names to ROR IDs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/mapping"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Map other organization IDs to ROR IDs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/grid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transition from GRID to ROR</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/funder-registry"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Transition from Open Funder Registry to ROR</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Sending ROR IDs</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/crossref"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to Crossref DOIs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/datacite"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to DataCite DOIs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/jats"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to JATS XML</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/orcid"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Add ROR IDs to ORCID records</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=ror" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>About the ROR REST API</h1></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/rest-api"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<blockquote class="callout callout_default" theme="1️⃣"><h2 class="callout-heading"><span class="callout-icon">1️⃣</span><p>ROR REST API v1</p></h2><p>This page documents v1 of the ROR REST API. For v2 documentation of the ROR REST API, see <a href="https://ror.readme.io/v2/docs/rest-api" target="" title="">https://ror.readme.io/v2/docs/rest-api</a>. You can also read more about ROR <a href="/docs/api-versions" target="" title="" class="doc-link" data-sidebar="api-versions">API versions</a> and a summary of what&#x27;s new in <a href="/docs/schema-v2" target="" title="" class="doc-link" data-sidebar="schema-v2">Schema 2.0</a> and <a href="/docs/schema-2-1" target="" title="" class="doc-link" data-sidebar="schema-2-1">Schema 2.1</a>.</p></blockquote> <p>The ROR REST API allows users to retrieve, search, and filter the organizations indexed in ROR. The API is built with Django, indexing and search is enabled by Elasticsearch, and results are returned as JSON. Version 1 of the ROR REST API is available at <strong><a href="https://api.ror.org/organizations" target="" title="">https://api.ror.org/organizations</a></strong> and at <strong><a href="https://api.ror.org/v1/organizations" target="" title="">https://api.ror.org/v1/organizations</a></strong>. Version 1 of the ROR API will be supported through at least April 2025, but <a href="https://ror.readme.io/v2/docs/rest-api" target="" title="">version 2 of the ROR API</a> is the current recommended version. </p> <p>Beginning 1 Dec 2022, the ROR API by default returns only records whose <a href="/docs/data-structure#status" target="" title="" class="doc-link" data-sidebar="data-structure#status">status</a> is &quot;active&quot;. Records with the new status values &quot;inactive&quot; and &quot;withdrawn&quot; can be included using the new query parameter <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">?all_status</code>. In addition, after this date, some ROR records contain the new values &quot;Predecessor&quot; and &quot;Successor&quot; in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships.type</code>. See <a href="https://ror.readme.io/changelog/2022-12-01-organization-status-changes" target="" title="">the 2022-12-01 changelog post</a> for more details.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="registration-and-rate-limits"></div><div class="heading-text"><div id="section-registration-and-rate-limits" class="heading-anchor_backwardsCompatibility"></div>Registration and rate limits</div><a aria-label="Skip link to Registration and rate limits" class="heading-anchor-icon fa fa-anchor" href="#registration-and-rate-limits"></a></h1> <p>No registration is required to use the ROR API, but note that the rate limit is a <strong>maximum of 2000 requests in a 5-minute period</strong>, and API traffic can be quite heavy at popular times like midnight UTC. If you need to make more requests or want to ensure faster response times, you can also run the entire ROR API locally in Docker. <a href="https://github.com/ror-community/ror-api#readme" target="" title="">See the README on the ROR API GitHub repository</a> for instructions on running the ROR API locally. </p> <blockquote class="callout callout_error" theme="❗️"><h2 class="callout-heading"><span class="callout-icon">❗️</span><p>It is not possible to retrieve all ROR records from the API</p></h2><p>The API is best for use cases that involve querying or retrieving individual records. The maximum number of results that can be retrieved via the API is 10,000, which means that it is currently not possible to retrieve all 100,000+ records from the ROR API. If you need to use the entire ROR dataset in your application, please download the <a href="https://ror.readme.io/docs/data-dump" target="" title="">data dump</a>.</p></blockquote> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="news-and-support"></div><div class="heading-text"><div id="section-news-and-support" class="heading-anchor_backwardsCompatibility"></div>News and support</div><a aria-label="Skip link to News and support" class="heading-anchor-icon fa fa-anchor" href="#news-and-support"></a></h1> <p>Users of the ROR API are strongly encouraged to sign up for the <a href="https://groups.google.com/a/ror.org/g/ror-tech" target="" title="">ROR Technical Forum</a> Google Group in order to receive announcements, calls for feedback, release notifications, and other important information about the ROR API. Message volume is about twice monthly. ROR API users are also welcome to ask technical questions in the group. </p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="heartbeat"></div><div class="heading-text"><div id="section-heartbeat" class="heading-anchor_backwardsCompatibility"></div>Heartbeat</div><a aria-label="Skip link to Heartbeat" class="heading-anchor-icon fa fa-anchor" href="#heartbeat"></a></h1> <p>If your application uses the ROR API and you&#x27;d like it to send a quick health check to determine if the ROR API is operational, you can send a query to the ROR API heartbeat at <a href="https://api.ror.org/heartbeat" target="" title="">https://api.ror.org/heartbeat</a>. If the ROR API is up, you will receive a status of <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">OK</code>.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="status-and-uptime"></div><div class="heading-text"><div id="section-status-and-uptime" class="heading-anchor_backwardsCompatibility"></div>Status and uptime</div><a aria-label="Skip link to Status and uptime" class="heading-anchor-icon fa fa-anchor" href="#status-and-uptime"></a></h1> <p>If you&#x27;d like to check manually on the status of the ROR API or assess its uptime, see <a href="https://ror1.statuspage.io" target="" title="">https://ror1.statuspage.io/</a> for full API status details and history. Our current API status and recent history is below. </p> <iframe href="https://ror1.statuspage.io" height="580px" width="100%" border="none" src="https://ror1.statuspage.io" style="border:none;display:flex;margin:auto"><a href="https://ror1.statuspage.io" target="" title="ror1.statuspage.io">ROR Status</a></iframe> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="usage-insights"></div><div class="heading-text"><div id="section-usage-insights" class="heading-anchor_backwardsCompatibility"></div>Usage insights</div><a aria-label="Skip link to Usage insights" class="heading-anchor-icon fa fa-anchor" href="#usage-insights"></a></h1> <p>Want to see how others are using the ROR API? Visit the <a href="https://p.datadoghq.eu/sb/db1aec04-0c1a-11ec-860a-da7ad0900005-7d7c572812608235cca3359ee5ec591a" target="" title="">public ROR API usage insights dashboard by DataDog</a>.</p>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><blockquote class="callout callout_default" theme="1️⃣"><h2 class="callout-heading"><span class="callout-icon">1️⃣</span><p>ROR REST API v1</p></h2><p>This page documents v1 of the ROR REST API. For v2 documentation of the ROR REST API, see <a target="_self" href="/v2/docs/rest-api">https://ror.readme.io/v2/docs/rest-api</a>. You can also read more about ROR <a target="_self" href="/docs/api-versions">API versions</a> and a summary of what's new in <a target="_self" href="/docs/schema-v2">Schema 2.0</a> and <a target="_self" href="/docs/schema-2-1">Schema 2.1</a>.</p></blockquote> <p>The ROR REST API allows users to retrieve, search, and filter the organizations indexed in ROR. The API is built with Django, indexing and search is enabled by Elasticsearch, and results are returned as JSON. Version 1 of the ROR REST API is available at <strong><a target="_self" href="https://api.ror.org/organizations">https://api.ror.org/organizations</a></strong> and at <strong><a target="_self" href="https://api.ror.org/v1/organizations">https://api.ror.org/v1/organizations</a></strong>. Version 1 of the ROR API will be supported through at least April 2025, but <a target="_self" href="/v2/docs/rest-api">version 2 of the ROR API</a> is the current recommended version. </p> <p>Beginning 1 Dec 2022, the ROR API by default returns only records whose <a target="_self" href="/docs/data-structure#status">status</a> is "active". Records with the new status values "inactive" and "withdrawn" can be included using the new query parameter <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">?all_status</code>. In addition, after this date, some ROR records contain the new values "Predecessor" and "Successor" in <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">relationships.type</code>. See <a target="_self" href="/changelog/2022-12-01-organization-status-changes">the 2022-12-01 changelog post</a> for more details.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="registration-and-rate-limits"></div><div class="heading-text"><div id="section-registration-and-rate-limits" class="heading-anchor_backwardsCompatibility"></div>Registration and rate limits</div><a aria-label="Skip link to Registration and rate limits" class="heading-anchor-icon fa fa-anchor" href="#registration-and-rate-limits"></a></h1> <p>No registration is required to use the ROR API, but note that the rate limit is a <strong>maximum of 2000 requests in a 5-minute period</strong>, and API traffic can be quite heavy at popular times like midnight UTC. If you need to make more requests or want to ensure faster response times, you can also run the entire ROR API locally in Docker. <a target="_self" href="https://github.com/ror-community/ror-api#readme">See the README on the ROR API GitHub repository</a> for instructions on running the ROR API locally. </p> <blockquote class="callout callout_error" theme="❗️"><h2 class="callout-heading"><span class="callout-icon">❗️</span><p>It is not possible to retrieve all ROR records from the API</p></h2><p>The API is best for use cases that involve querying or retrieving individual records. The maximum number of results that can be retrieved via the API is 10,000, which means that it is currently not possible to retrieve all 100,000+ records from the ROR API. If you need to use the entire ROR dataset in your application, please download the <a target="_self" href="/docs/data-dump">data dump</a>.</p></blockquote> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="news-and-support"></div><div class="heading-text"><div id="section-news-and-support" class="heading-anchor_backwardsCompatibility"></div>News and support</div><a aria-label="Skip link to News and support" class="heading-anchor-icon fa fa-anchor" href="#news-and-support"></a></h1> <p>Users of the ROR API are strongly encouraged to sign up for the <a target="_self" href="https://groups.google.com/a/ror.org/g/ror-tech">ROR Technical Forum</a> Google Group in order to receive announcements, calls for feedback, release notifications, and other important information about the ROR API. Message volume is about twice monthly. ROR API users are also welcome to ask technical questions in the group. </p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="heartbeat"></div><div class="heading-text"><div id="section-heartbeat" class="heading-anchor_backwardsCompatibility"></div>Heartbeat</div><a aria-label="Skip link to Heartbeat" class="heading-anchor-icon fa fa-anchor" href="#heartbeat"></a></h1> <p>If your application uses the ROR API and you'd like it to send a quick health check to determine if the ROR API is operational, you can send a query to the ROR API heartbeat at <a target="_self" href="https://api.ror.org/heartbeat">https://api.ror.org/heartbeat</a>. If the ROR API is up, you will receive a status of <button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang- theme-light" data-lang="" name="" tabindex="0">OK</code>.</p> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="status-and-uptime"></div><div class="heading-text"><div id="section-status-and-uptime" class="heading-anchor_backwardsCompatibility"></div>Status and uptime</div><a aria-label="Skip link to Status and uptime" class="heading-anchor-icon fa fa-anchor" href="#status-and-uptime"></a></h1> <p>If you'd like to check manually on the status of the ROR API or assess its uptime, see <a target="_self" href="https://ror1.statuspage.io">https://ror1.statuspage.io/</a> for full API status details and history. Our current API status and recent history is below. </p> <iframe href="https://ror1.statuspage.io" height="580px" width="100%" border="none" src="https://ror1.statuspage.io" style="border:none;display:flex;margin:auto"><a target="_self" href="https://ror1.statuspage.io" title="ror1.statuspage.io">ROR Status</a></iframe> <h1 class="heading heading-1 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="usage-insights"></div><div class="heading-text"><div id="section-usage-insights" class="heading-anchor_backwardsCompatibility"></div>Usage insights</div><a aria-label="Skip link to Usage insights" class="heading-anchor-icon fa fa-anchor" href="#usage-insights"></a></h1> <p>Want to see how others are using the ROR API? Visit the <a target="_self" href="https://p.datadoghq.eu/sb/db1aec04-0c1a-11ec-860a-da7ad0900005-7d7c572812608235cca3359ee5ec591a">public ROR API usage insights dashboard by DataDog</a>.</p></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated 3 months ago </p></div><hr class="NextStepsDivider"/><div class="WhatsNext-wrapper3DTnpcPqKoHg"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader WhatsNext-headingQHN33r4trf_s"><div class="APISectionHeader-heading4MUMLbp4_nLs">Other resources you might find helpful</div></header><div class="rm-Markdown markdown-body WhatsNext-description1zZyZLPCGmaa WhatsNext-description_empty1Hh8M1AKGhbW" data-testid="RDMD"></div><ul><li><a class="WhatsNext-link" target="_self" href="/docs/api-versions">API versions</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-single">Retrieve a single record</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-list">Retrieve a list of records</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-filtering">Filtering</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-paging">Paging</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-query">Query parameter</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-advanced-query">Advanced query parameter</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-affiliation">Affiliation parameter</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/docs/api-v2">ROR schema & API v2 (beta)</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li></ul></div></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li><a href="#registration-and-rate-limits">Registration and rate limits</a></li> <li><a href="#news-and-support">News and support</a></li> <li><a href="#heartbeat">Heartbeat</a></li> <li><a href="#status-and-uptime">Status and uptime</a></li> <li><a href="#usage-insights">Usage insights</a></li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"60d25b23765a5900437c8fce","title":"Getting Started with ROR","slug":"getting-started","order":1,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:50:27.898Z","__v":0,"pages":[{"_id":"60d25d491c90f40053e991e0","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":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"62fb961f8d112700211bbf15","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Identifier pattern","icon":"","type":"basic","slug":"identifier","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-identifier-pattern","createdAt":"2022-08-16T13:05:35.053Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"630d0205f1b18c003de1d215","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Logos and display guidelines","icon":"","type":"basic","slug":"display","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-id-display-guidelines-and-logos","createdAt":"2022-08-29T18:14:29.139Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60f8832f8d0c540065cf57a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"See who uses ROR","type":"basic","slug":"integrations","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-integrations","createdAt":"2021-07-21T20:27:27.858Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60f88138b824e4001ccd7e71","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get involved","type":"basic","slug":"get-involved","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-07-21T20:19:04.850Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6466838e94b6bb00501efe6a","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Community feedback documents","icon":"","type":"basic","slug":"feedback-docs","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"community-feedback-documents","category":"60d25b23765a5900437c8fce","createdAt":"2023-05-18T19:59:10.204Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60d5e6e464e12b0055eda723","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Contact us","type":"basic","slug":"contact","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-in-touch","createdAt":"2021-06-25T14:23:32.577Z","category":"60d25b23765a5900437c8fce","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"65ec6c03aff86d0072a566d7","title":"ROR Metadata","slug":"ror-metadata","order":3,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2024-03-09T14:02:43.834Z","__v":0,"pages":[{"_id":"60d25d9079d8a0002a2a0da0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Updates and curation","type":"basic","slug":"updates","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-ror-is-updated","createdAt":"2021-06-22T22:00:48.485Z","category":"65ec6c03aff86d0072a566d7","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60d25da0b85dae005598be27","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Data structure","type":"basic","slug":"data-structure","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-data-structure","createdAt":"2021-06-22T22:01:04.607Z","category":"65ec6c03aff86d0072a566d7","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6441a31ed32dc616a0b51f7b","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Fields and sub-fields","icon":"","type":"basic","slug":"fields","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"all-ror-fields-and-sub-fields","category":"65ec6c03aff86d0072a566d7","createdAt":"2023-04-20T20:39:58.302Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63ea71505bccd0025b40056a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Relationships and hierarchies","icon":"","type":"basic","slug":"relationships","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"ror-hierarchies-and-relationships","category":"65ec6c03aff86d0072a566d7","createdAt":"2023-02-13T17:20:16.915Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6441b9979730ea1a3d0b0afb","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":"65ec6c03aff86d0072a566d7","createdAt":"2023-04-20T22:15:51.461Z","isBodyEmpty":false,"children":[]},{"_id":"6464d64fef9bab0066e99315","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Schema 2.0","icon":"","type":"basic","slug":"schema-v2","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-v20","parentDoc":null,"category":"65ec6c03aff86d0072a566d7","createdAt":"2023-05-17T13:27:43.797Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"675c406280b1ad0069206e7e","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","parentDoc":null,"category":"65ec6c03aff86d0072a566d7","createdAt":"2024-12-13T14:10:42.980Z","isBodyEmpty":false,"children":[]}]},{"_id":"653c1e6f1cd9f1004b55cc72","title":"ROR REST API","slug":"rest-api","order":5,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2023-10-27T20:32:47.999Z","__v":0,"pages":[{"_id":"63fc803674ca3e0045af2ddb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"About the ROR REST API","icon":"","type":"basic","slug":"rest-api","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"api-about","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-02-27T10:04:38.511Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6465068f99bbc20028cc7084","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Retrieve a single record","icon":"","type":"basic","slug":"api-single","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-single-ror-record","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T16:53:35.628Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6465071071aace1d6f61fd7e","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Retrieve a list of records","icon":"","type":"basic","slug":"api-list","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-list-of-ror-records","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T16:55:44.021Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"646564ed6206730045608ea7","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Filtering","icon":"","type":"basic","slug":"api-filtering","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"filtering","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T23:36:13.204Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"646564bf25682100246d7641","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Paging","icon":"","type":"basic","slug":"api-paging","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"paging","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-05-17T23:35:27.796Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63d1a47566e590002a7fc9d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Query parameter","icon":"","type":"basic","slug":"api-query","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"query-parameter","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-01-25T21:51:49.092Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"641211ffd09495007a04c5b0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Advanced query parameter","icon":"","type":"basic","slug":"api-advanced-query","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"advanced-query-parameter","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-03-15T18:44:15.278Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63d1a4b9149169004c68b881","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Affiliation parameter","icon":"","type":"basic","slug":"api-affiliation","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"affiliation-parameter","parentDoc":null,"category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-01-25T21:52:57.629Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6441a7b0de10cd149041710c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"API versions","icon":"","type":"basic","slug":"api-versions","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-and-api-versioning-1","category":"653c1e6f1cd9f1004b55cc72","createdAt":"2023-04-20T20:59:28.209Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"60d25b780dfce1003f4547aa","title":"ROR Tools & Services","slug":"tools-services","order":6,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:51:52.183Z","__v":0,"pages":[{"_id":"60d3d01ac6b0030070645391","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Data dump","type":"basic","slug":"data-dump","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-24T00:21:46.090Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60fee88bae1bb3000f317da2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Web search","type":"basic","slug":"web-search","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"web-search-interface","createdAt":"2021-07-26T16:53:31.701Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60d3d0249841a7004a372925","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"OpenRefine reconciler","type":"basic","slug":"openrefine-reconciler","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-24T00:21:56.714Z","category":"60d25b780dfce1003f4547aa","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"64426d364b8f4c00604bb504","title":"Collecting ROR IDs","slug":"mapping-and-matching","order":7,"reference":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2023-04-21T11:02:14.913Z","__v":0,"pages":[{"_id":"6388f77b6c803f0024576f3d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create ROR-powered forms","icon":"","type":"basic","slug":"forms","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-ror-powered-typeaheads","createdAt":"2022-12-01T18:50:35.957Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60d3e4c27dccd0004443bc84","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Match organization names to ROR IDs","type":"basic","slug":"matching","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"match-organization-names-to-ror-ids","createdAt":"2021-06-24T01:49:54.894Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60d3e492c16abe006427745b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Map other organization IDs to ROR IDs","type":"basic","slug":"mapping","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"map-other-organization-id-types-to-ror","createdAt":"2021-06-24T01:49:06.244Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"60f0d77625052e007e5fdeea","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Transition from GRID to ROR","type":"basic","slug":"grid","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"gridror-transition-faq","createdAt":"2021-07-16T00:48:54.225Z","category":"64426d364b8f4c00604bb504","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"65e8e50442039e001d1bf878","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Transition from Open Funder Registry to ROR","icon":"","type":"basic","slug":"funder-registry","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"open-funder-registry-ror-transition-faq","category":"64426d364b8f4c00604bb504","createdAt":"2024-03-06T21:49:56.732Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"60d25b63bd8660001006bcba","title":"Sending ROR IDs","slug":"implementation-how-to-guides","order":8,"reference":false,"isAPI":false,"project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2021-06-22T21:51:31.872Z","__v":0,"pages":[{"_id":"6441b9fc874e64005e3748cb","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Add ROR IDs to Crossref DOIs","icon":"","type":"basic","slug":"crossref","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-crossref-dois","category":"60d25b63bd8660001006bcba","createdAt":"2023-04-20T22:17:32.825Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6441ba1deda7550012b9c1df","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Add ROR IDs to DataCite DOIs","icon":"","type":"basic","slug":"datacite","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-datacite-dois","category":"60d25b63bd8660001006bcba","createdAt":"2023-04-20T22:18:05.994Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6320a168f8e794131108ae63","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Add ROR IDs to JATS XML","icon":"","type":"basic","slug":"jats","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-jats-xml","createdAt":"2022-09-13T15:27:36.976Z","category":"60d25b63bd8660001006bcba","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6182d13df84631005aa3c8e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Add ROR IDs to ORCID records","type":"basic","slug":"orcid","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"include-ror-ids-in-orcid-record-data","createdAt":"2021-11-03T18:13:17.918Z","category":"60d25b63bd8660001006bcba","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]}]}],"refs":[]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"ODczNzdiMDdiZDc1ZWRiOGQyYWVlYzVjMTdiMjg3ZmEwNWUyZDk3YWJlMDc5ZTliNmFhNTE2ZWY3ZDhiOGUyZnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODM3KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"6058e47681775f002de04832","name":"ROR","subdomain":"ror","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"ror"},"version":"1"}},"activeDoc":"rest-api","rdmd":{"baseUrl":"/","body":"> 1️⃣ ROR REST API v1\n> \n> This page documents v1 of the ROR REST API. For v2 documentation of the ROR REST API, see <https://ror.readme.io/v2/docs/rest-api>. You can also read more about ROR [API versions](doc:api-versions) and a summary of what's new in [Schema 2.0](doc:schema-v2) and [Schema 2.1](doc:schema-2-1).\n\nThe ROR REST API allows users to retrieve, search, and filter the organizations indexed in ROR. The API is built with Django, indexing and search is enabled by Elasticsearch, and results are returned as JSON. Version 1 of the ROR REST API is available at **<https://api.ror.org/organizations>** and at **<https://api.ror.org/v1/organizations>**. Version 1 of the ROR API will be supported through at least April 2025, but [version 2 of the ROR API](https://ror.readme.io/v2/docs/rest-api) is the current recommended version. \n\nBeginning 1 Dec 2022, the ROR API by default returns only records whose [status](doc:data-structure#status) is \"active\". Records with the new status values \"inactive\" and \"withdrawn\" can be included using the new query parameter `?all_status`. In addition, after this date, some ROR records contain the new values \"Predecessor\" and \"Successor\" in `relationships.type`. See [the 2022-12-01 changelog post](https://ror.readme.io/changelog/2022-12-01-organization-status-changes) for more details.\n\n# Registration and rate limits\n\nNo registration is required to use the ROR API, but note that the rate limit is a **maximum of 2000 requests in a 5-minute period**, and API traffic can be quite heavy at popular times like midnight UTC. If you need to make more requests or want to ensure faster response times, you can also run the entire ROR API locally in Docker. [See the README on the ROR API GitHub repository](https://github.com/ror-community/ror-api#readme) for instructions on running the ROR API locally. \n\n> ❗️ It is not possible to retrieve all ROR records from the API\n> \n> The API is best for use cases that involve querying or retrieving individual records. The maximum number of results that can be retrieved via the API is 10,000, which means that it is currently not possible to retrieve all 100,000+ records from the ROR API. If you need to use the entire ROR dataset in your application, please download the [data dump](https://ror.readme.io/docs/data-dump).\n\n# News and support\n\nUsers of the ROR API are strongly encouraged to sign up for the [ROR Technical Forum](https://groups.google.com/a/ror.org/g/ror-tech) Google Group in order to receive announcements, calls for feedback, release notifications, and other important information about the ROR API. Message volume is about twice monthly. ROR API users are also welcome to ask technical questions in the group. \n\n# Heartbeat\n\nIf your application uses the ROR API and you'd like it to send a quick health check to determine if the ROR API is operational, you can send a query to the ROR API heartbeat at <https://api.ror.org/heartbeat>. If the ROR API is up, you will receive a status of `OK`.\n\n# Status and uptime\n\nIf you'd like to check manually on the status of the ROR API or assess its uptime, see [https://ror1.statuspage.io/](https://ror1.statuspage.io) for full API status details and history. Our current API status and recent history is below. \n\n[block:embed]\n{\n \"html\": false,\n \"url\": \"https://ror1.statuspage.io\",\n \"title\": \"ROR Status\",\n \"favicon\": \"https://dka575ofm4ao0.cloudfront.net/assets/logos/favicon-2b86ed00cfa6258307d4a3d0c482fd733c7973f82de213143b24fc062c540367.png\",\n \"image\": \"https://dka575ofm4ao0.cloudfront.net/pages-transactional_logos/retina/88244/ROR.org_Port_RGB_Large.jpg\",\n \"provider\": \"ror1.statuspage.io\",\n \"href\": \"https://ror1.statuspage.io\",\n \"height\": \"580px\",\n \"iframe\": true\n}\n[/block]\n\n\n# Usage insights\n\nWant to see how others are using the ROR API? Visit the [public ROR API usage insights dashboard by DataDog](https://p.datadoghq.eu/sb/db1aec04-0c1a-11ec-860a-da7ad0900005-7d7c572812608235cca3359ee5ec591a).","dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li><a href=\"#registration-and-rate-limits\">Registration and rate limits</a></li>\n<li><a href=\"#news-and-support\">News and support</a></li>\n<li><a href=\"#heartbeat\">Heartbeat</a></li>\n<li><a href=\"#status-and-uptime\">Status and uptime</a></li>\n<li><a href=\"#usage-insights\">Usage insights</a></li>\n</ul></li></ul></nav>","body":"<blockquote class=\"callout callout_default\" theme=\"1️⃣\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">1️⃣</span><p>ROR REST API v1</p></h2><p>This page documents v1 of the ROR REST API. For v2 documentation of the ROR REST API, see <a href=\"https://ror.readme.io/v2/docs/rest-api\" target=\"\" title=\"\">https://ror.readme.io/v2/docs/rest-api</a>. You can also read more about ROR <a href=\"/docs/api-versions\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"api-versions\">API versions</a> and a summary of what&#x27;s new in <a href=\"/docs/schema-v2\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-v2\">Schema 2.0</a> and <a href=\"/docs/schema-2-1\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"schema-2-1\">Schema 2.1</a>.</p></blockquote>\n<p>The ROR REST API allows users to retrieve, search, and filter the organizations indexed in ROR. The API is built with Django, indexing and search is enabled by Elasticsearch, and results are returned as JSON. Version 1 of the ROR REST API is available at <strong><a href=\"https://api.ror.org/organizations\" target=\"\" title=\"\">https://api.ror.org/organizations</a></strong> and at <strong><a href=\"https://api.ror.org/v1/organizations\" target=\"\" title=\"\">https://api.ror.org/v1/organizations</a></strong>. Version 1 of the ROR API will be supported through at least April 2025, but <a href=\"https://ror.readme.io/v2/docs/rest-api\" target=\"\" title=\"\">version 2 of the ROR API</a> is the current recommended version. </p>\n<p>Beginning 1 Dec 2022, the ROR API by default returns only records whose <a href=\"/docs/data-structure#status\" target=\"\" title=\"\" class=\"doc-link\" data-sidebar=\"data-structure#status\">status</a> is &quot;active&quot;. Records with the new status values &quot;inactive&quot; and &quot;withdrawn&quot; can be included using the new query parameter <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">?all_status</code>. In addition, after this date, some ROR records contain the new values &quot;Predecessor&quot; and &quot;Successor&quot; in <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">relationships.type</code>. See <a href=\"https://ror.readme.io/changelog/2022-12-01-organization-status-changes\" target=\"\" title=\"\">the 2022-12-01 changelog post</a> for more details.</p>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"registration-and-rate-limits\"></div><div class=\"heading-text\"><div id=\"section-registration-and-rate-limits\" class=\"heading-anchor_backwardsCompatibility\"></div>Registration and rate limits</div><a aria-label=\"Skip link to Registration and rate limits\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#registration-and-rate-limits\"></a></h1>\n<p>No registration is required to use the ROR API, but note that the rate limit is a <strong>maximum of 2000 requests in a 5-minute period</strong>, and API traffic can be quite heavy at popular times like midnight UTC. If you need to make more requests or want to ensure faster response times, you can also run the entire ROR API locally in Docker. <a href=\"https://github.com/ror-community/ror-api#readme\" target=\"\" title=\"\">See the README on the ROR API GitHub repository</a> for instructions on running the ROR API locally. </p>\n<blockquote class=\"callout callout_error\" theme=\"❗️\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">❗️</span><p>It is not possible to retrieve all ROR records from the API</p></h2><p>The API is best for use cases that involve querying or retrieving individual records. The maximum number of results that can be retrieved via the API is 10,000, which means that it is currently not possible to retrieve all 100,000+ records from the ROR API. If you need to use the entire ROR dataset in your application, please download the <a href=\"https://ror.readme.io/docs/data-dump\" target=\"\" title=\"\">data dump</a>.</p></blockquote>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"news-and-support\"></div><div class=\"heading-text\"><div id=\"section-news-and-support\" class=\"heading-anchor_backwardsCompatibility\"></div>News and support</div><a aria-label=\"Skip link to News and support\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#news-and-support\"></a></h1>\n<p>Users of the ROR API are strongly encouraged to sign up for the <a href=\"https://groups.google.com/a/ror.org/g/ror-tech\" target=\"\" title=\"\">ROR Technical Forum</a> Google Group in order to receive announcements, calls for feedback, release notifications, and other important information about the ROR API. Message volume is about twice monthly. ROR API users are also welcome to ask technical questions in the group. </p>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"heartbeat\"></div><div class=\"heading-text\"><div id=\"section-heartbeat\" class=\"heading-anchor_backwardsCompatibility\"></div>Heartbeat</div><a aria-label=\"Skip link to Heartbeat\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#heartbeat\"></a></h1>\n<p>If your application uses the ROR API and you&#x27;d like it to send a quick health check to determine if the ROR API is operational, you can send a query to the ROR API heartbeat at <a href=\"https://api.ror.org/heartbeat\" target=\"\" title=\"\">https://api.ror.org/heartbeat</a>. If the ROR API is up, you will receive a status of <button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\" tabindex=\"0\">OK</code>.</p>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"status-and-uptime\"></div><div class=\"heading-text\"><div id=\"section-status-and-uptime\" class=\"heading-anchor_backwardsCompatibility\"></div>Status and uptime</div><a aria-label=\"Skip link to Status and uptime\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#status-and-uptime\"></a></h1>\n<p>If you&#x27;d like to check manually on the status of the ROR API or assess its uptime, see <a href=\"https://ror1.statuspage.io\" target=\"\" title=\"\">https://ror1.statuspage.io/</a> for full API status details and history. Our current API status and recent history is below. </p>\n<iframe href=\"https://ror1.statuspage.io\" height=\"580px\" width=\"100%\" border=\"none\" src=\"https://ror1.statuspage.io\" style=\"border:none;display:flex;margin:auto\"><a href=\"https://ror1.statuspage.io\" target=\"\" title=\"ror1.statuspage.io\">ROR Status</a></iframe>\n<h1 class=\"heading heading-1 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"usage-insights\"></div><div class=\"heading-text\"><div id=\"section-usage-insights\" class=\"heading-anchor_backwardsCompatibility\"></div>Usage insights</div><a aria-label=\"Skip link to Usage insights\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#usage-insights\"></a></h1>\n<p>Want to see how others are using the ROR API? Visit the <a href=\"https://p.datadoghq.eu/sb/db1aec04-0c1a-11ec-860a-da7ad0900005-7d7c572812608235cca3359ee5ec591a\" target=\"\" title=\"\">public ROR API usage insights dashboard by DataDog</a>.</p>"},"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{}},"safeMode":false,"settings":{"position":true},"theme":"light","customBlocks":{},"resourceID":"63fc803674ca3e0045af2ddb","resourceType":"page","baseUrl":"/","terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]}},"terms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"mdx":false},"doc":{"metadata":{"image":[],"title":"About the ROR REST API","description":"Recent changes to the ROR REST API include default return of only active records, new query parameter for all statuses, and updated values in status and relationships. Users can access the API without registration, but there is a rate limit of 2000 requests in a 5-minute period. Join the ROR Technical Forum for updates and support, and check the API status at ror1.statuspage.io.","keywords":"ROR REST API","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"next":{"description":"","pages":[{"name":"API versions","slug":"api-versions","type":"doc","category":"ROR REST API"},{"name":"Retrieve a single record","slug":"api-single","type":"doc","category":"ROR REST API"},{"name":"Retrieve a list of records","slug":"api-list","type":"doc","category":"ROR REST API"},{"name":"Filtering","slug":"api-filtering","type":"doc","category":"ROR REST API"},{"name":"Paging","slug":"api-paging","type":"doc","category":"ROR REST API"},{"name":"Query parameter","slug":"api-query","type":"doc","category":"ROR REST API"},{"name":"Advanced query parameter","slug":"api-advanced-query","type":"doc","category":"ROR REST API"},{"name":"Affiliation parameter","slug":"api-affiliation","type":"doc","category":"ROR REST API"},{"name":"ROR schema & API v2 (beta)","slug":"api-v2","type":"doc","category":"ROR REST API"}]},"algolia":{"recordCount":6,"publishPending":false,"translationFailure":false,"updatedAt":"2024-12-14T01:57:28.705Z"},"title":"About the ROR REST API","icon":"","updates":[],"type":"basic","slug":"rest-api","excerpt":"","body":"> 1️⃣ ROR REST API v1\n> \n> This page documents v1 of the ROR REST API. For v2 documentation of the ROR REST API, see <https://ror.readme.io/v2/docs/rest-api>. You can also read more about ROR [API versions](doc:api-versions) and a summary of what's new in [Schema 2.0](doc:schema-v2) and [Schema 2.1](doc:schema-2-1).\n\nThe ROR REST API allows users to retrieve, search, and filter the organizations indexed in ROR. The API is built with Django, indexing and search is enabled by Elasticsearch, and results are returned as JSON. Version 1 of the ROR REST API is available at **<https://api.ror.org/organizations>** and at **<https://api.ror.org/v1/organizations>**. Version 1 of the ROR API will be supported through at least April 2025, but [version 2 of the ROR API](https://ror.readme.io/v2/docs/rest-api) is the current recommended version. \n\nBeginning 1 Dec 2022, the ROR API by default returns only records whose [status](doc:data-structure#status) is \"active\". Records with the new status values \"inactive\" and \"withdrawn\" can be included using the new query parameter `?all_status`. In addition, after this date, some ROR records contain the new values \"Predecessor\" and \"Successor\" in `relationships.type`. See [the 2022-12-01 changelog post](https://ror.readme.io/changelog/2022-12-01-organization-status-changes) for more details.\n\n# Registration and rate limits\n\nNo registration is required to use the ROR API, but note that the rate limit is a **maximum of 2000 requests in a 5-minute period**, and API traffic can be quite heavy at popular times like midnight UTC. If you need to make more requests or want to ensure faster response times, you can also run the entire ROR API locally in Docker. [See the README on the ROR API GitHub repository](https://github.com/ror-community/ror-api#readme) for instructions on running the ROR API locally. \n\n> ❗️ It is not possible to retrieve all ROR records from the API\n> \n> The API is best for use cases that involve querying or retrieving individual records. The maximum number of results that can be retrieved via the API is 10,000, which means that it is currently not possible to retrieve all 100,000+ records from the ROR API. If you need to use the entire ROR dataset in your application, please download the [data dump](https://ror.readme.io/docs/data-dump).\n\n# News and support\n\nUsers of the ROR API are strongly encouraged to sign up for the [ROR Technical Forum](https://groups.google.com/a/ror.org/g/ror-tech) Google Group in order to receive announcements, calls for feedback, release notifications, and other important information about the ROR API. Message volume is about twice monthly. ROR API users are also welcome to ask technical questions in the group. \n\n# Heartbeat\n\nIf your application uses the ROR API and you'd like it to send a quick health check to determine if the ROR API is operational, you can send a query to the ROR API heartbeat at <https://api.ror.org/heartbeat>. If the ROR API is up, you will receive a status of `OK`.\n\n# Status and uptime\n\nIf you'd like to check manually on the status of the ROR API or assess its uptime, see [https://ror1.statuspage.io/](https://ror1.statuspage.io) for full API status details and history. Our current API status and recent history is below. \n\n[block:embed]\n{\n \"html\": false,\n \"url\": \"https://ror1.statuspage.io\",\n \"title\": \"ROR Status\",\n \"favicon\": \"https://dka575ofm4ao0.cloudfront.net/assets/logos/favicon-2b86ed00cfa6258307d4a3d0c482fd733c7973f82de213143b24fc062c540367.png\",\n \"image\": \"https://dka575ofm4ao0.cloudfront.net/pages-transactional_logos/retina/88244/ROR.org_Port_RGB_Large.jpg\",\n \"provider\": \"ror1.statuspage.io\",\n \"href\": \"https://ror1.statuspage.io\",\n \"height\": \"580px\",\n \"iframe\": true\n}\n[/block]\n\n\n# Usage insights\n\nWant to see how others are using the ROR API? Visit the [public ROR API usage insights dashboard by DataDog](https://p.datadoghq.eu/sb/db1aec04-0c1a-11ec-860a-da7ad0900005-7d7c572812608235cca3359ee5ec591a).","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"api-about","slugUpdatedAt":"2024-03-13T13:13:24.460Z","revision":76,"_id":"63fc803674ca3e0045af2ddb","user":"62a72c1fbac94d016a0d28fe","project":"6058e47681775f002de04832","category":{"title":"ROR REST API","slug":"rest-api","order":5,"reference":false,"_id":"653c1e6f1cd9f1004b55cc72","project":"6058e47681775f002de04832","version":"6058e47681775f002de04837","createdAt":"2023-10-27T20:32:47.999Z","__v":0,"type":"guide","id":"653c1e6f1cd9f1004b55cc72"},"createdAt":"2023-02-27T10:04:38.511Z","updatedAt":"2024-12-14T01:57:28.711Z","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"pdfStatus":"","_id":"6058e47681775f002de04837","project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"__v":4,"parentDoc":null,"lastUpdatedHash":"09ffdb23a7246a3f8c6c6457e4993e39620c00b3","isApi":false,"tutorials":[],"id":"63fc803674ca3e0045af2ddb"},"hideTOC":false,"meta":{"_id":"63fc803674ca3e0045af2ddb","description":"Recent changes to the ROR REST API include default return of only active records, new query parameter for all statuses, and updated values in status and relationships. Users can access the API without registration, but there is a rate limit of 2000 requests in a 5-minute period. Join the ROR Technic...","hidden":false,"image":[],"keywords":"ROR REST API","metaTitle":"About the ROR REST API","parent":null,"robots":"index","slug":"rest-api","title":"About the ROR REST API","type":"docs"},"slugUrl":"/docs/rest-api","config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.294.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,"localLLM":false,"superHubManageVersions":false,"gitSidebar":true},"fullBaseUrl":"https://ror.readme.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text","alignment":"left","title":"Announcing ROR schema 2.1!","text":"We've just released a new non-breaking update to the ROR schema that adds location information for continents and country subdivisions to ROR records. Read more about Schema 2.1 in the changelog at https://ror.readme.io/changelog/2024-12-12-schema-v2-1."},{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"name":"ROR","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"freelaunch","planOverride":"opensource","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"","planTrial":"opensource","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":false,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":false,"points":2}},"percentScore":25,"totalScore":70},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":true},"stable":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"subdomain":"ror","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"url","text":"Report a bug or request a feature","url":"https://github.com/ror-community/ror-roadmap/issues/new/choose"},{"type":"url","text":"Contact support","url":"mailto:support@ror.org"}],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/docs/rest-api"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2021-04-05T18:39:50.145Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://ror.org","versions":[{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},{"_id":"66072096d9631f0054e8c118","version":"2","version_clean":"2.0.0","codename":"","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","66072096d9631f0054e8c0ea","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","66072096d9631f0054e8c0ee","66072096d9631f0054e8c0ef","66072096d9631f0054e8c0f0","66072097d9631f0054e8c11a"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2024-03-29T20:12:06.845Z","__v":0,"updatedAt":"2024-04-11T20:46:41.478Z","forked_from":"6058e47681775f002de04837"}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"6058e47681775f002de04833","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"canonical_url":null,"default_version":{"name":"1"},"description":"Technical documentation for ROR, the Research Organization Registry, a global, community-led registry of open persistent identifiers for research organizations.","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":{"custom_components":"disabled","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"}}}}}},"version":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"}},"reqUrl":"/docs/rest-api","version":{"_id":"6058e47681775f002de04837","version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6058e47681775f002de04839","6058e47681775f002de04839","6058e47681775f002de0483f","60d3d003d5ef44000f12c6c5","60de178b3321e40069edd8ac","63581e7c2875a60bd7564745","6376be56127d99000315eda9","64426d364b8f4c00604bb504","653c1e6f1cd9f1004b55cc72","65ec6c03aff86d0072a566d7"],"project":"6058e47681775f002de04832","releaseDate":"2021-03-22T18:39:50.198Z","createdAt":"2021-03-22T18:39:50.198Z","__v":2,"updatedAt":"2024-04-11T20:46:41.458Z"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6601,3622,9772,4904,7449,7372,9082,734,954,6903,2395,8161,1008,7188,5753,2852,9930,7783,1456,1666,5798,4935,4287,4201,1936,6922,2859,5948,8230,1313,1202,4002,3787,1343,2578,6060,3859,3221,7327,7717,5359,3307,7356,2144,9141,1080,9852,8684,9575,3626,8063,5408,2637,2402,678,4674,1731,2616,3412,4793,4467,7031,2705,169,2548,2183,4778,3556]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-PageNotFound","Footer","core-icons-chevron-up-down-svg","routes-Doc","CustomPage","routes-Reference","core-icons-alert-circle-svg","routes-Landing","core-icons-more-vertical-svg","core-icons-eye-off-svg","core-icons-lock-svg","core-icons-chevron-down-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","RMDX","routes-Changelog","Post","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-arrow-right-svg","core-icons-book-svg","core-icons-arrow-up-right-svg","routes-Discuss","Page","core-icons-webhook-svg","List","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-CustomPage","core-icons-star-svg","routes-Tutorials","core-icons-message-circle-svg","core-icons-chevron-right-svg","core-icons-plus-svg","core-icons-folder-plus-svg","core-icons-file-svg","core-icons-eye-svg","core-icons-key-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.5291198bd71a134466e9.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/3622.30b9cb2443fabb238262.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.dcd45762ee393f583fea.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4904.df63e6b74f3878787175.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.4f5a59d2f86c6ece493b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/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/6903.75b9333e2c99d6924d0e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.93b03fc4eb8efabb08a7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8161.c06bb55544d4d5ece838.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1008.4c339ef2e2b87bbd1d0b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7188.9cd5fd7fe0a05ab94dea.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5753.887d4d8ae5466a3f3b2a.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.6d52d3d479e7e6844ace.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.2497238876f4f363107c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.85a768f818d97858fce7.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.852328ff472332820e4a.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.43a913423ff21c406134.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.fe60df69c20b2ce54513.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.f81f304a0f9e9f73d47e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.638ac41f3269eb8fe633.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/8230.128cfdd53c803eea12b2.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.f1f59d6d6f3fec6c0a4e.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-Landing" src="https://cdn.readme.io/public/hub/web/4002.704e628347d37011965d.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.1ea18c7d8e69fc7252af.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-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-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/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.5cae0557d05c869c77bf.js"></script> <script async data-chunk="RMDX" src="https://cdn.readme.io/public/hub/web/RMDX.aefe00bd92fd4e78ab65.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.80a45bec48d0ae892ab7.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.34fb79ca63e7ed2617d0.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.85c89705122f7bc8f4f3.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="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="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-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-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.dae2f8e80d2d75f106bd.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.f161cf21b4202fcf0f18.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.4e99fc9641c6a023c75a.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="List" src="https://cdn.readme.io/public/hub/web/4674.6e1931c1363cea798412.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.a16df6acd7d10a15e9da.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-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.c491da97152573555d9f.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="core-icons-chevron-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-right-svg.34d126524d8ea236d174.js"></script> <script async data-chunk="core-icons-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-plus-svg.a49fb76ac2661b5e1c7e.js"></script> <script async data-chunk="core-icons-folder-plus-svg" src="https://cdn.readme.io/public/hub/web/core-icons-folder-plus-svg.2c200438e59611867262.js"></script> <script async data-chunk="core-icons-file-svg" src="https://cdn.readme.io/public/hub/web/core-icons-file-svg.24d3e20044ef331cf0d2.js"></script> <script async data-chunk="core-icons-eye-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-svg.b2103692a3c209893efe.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></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"ODczNzdiMDdiZDc1ZWRiOGQyYWVlYzVjMTdiMjg3ZmEwNWUyZDk3YWJlMDc5ZTliNmFhNTE2ZWY3ZDhiOGUyZnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODMyKSwodmVyc2lvbjpub25lLHZlcnNpb246NjA1OGU0NzY4MTc3NWYwMDJkZTA0ODM3KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:6058e47681775f002de04832),(version:none,version:6058e47681775f002de04837),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"id":"6058e47681775f002de04832","name":"ROR","subdomain":"ror","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

About the ROR REST API