

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  

  <link rel="icon" href="/img/favicon.png" type="image/x-icon">



  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>ReliefWeb API Documentation | Documentation for the ReliefWeb API</title>
<meta name="generator" content="Jekyll v3.10.0" />
<meta property="og:title" content="ReliefWeb API Documentation" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Documentation for the ReliefWeb API" />
<meta property="og:description" content="Documentation for the ReliefWeb API" />
<link rel="canonical" href="https://apidoc.reliefweb.int/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://apidoc.reliefweb.int/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="ReliefWeb API Documentation" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="ReliefWeb API Documentation" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Documentation for the ReliefWeb API","headline":"ReliefWeb API Documentation","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://apidoc.reliefweb.int/img/rw-api-logo.svg"}},"url":"https://apidoc.reliefweb.int/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  <link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" rel="stylesheet">
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-M4X6LPS');</script>
<!-- End Google Tag Manager -->



</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <div class="side-bar">
  <div class="site-header" role="banner">
    <a href="/" class="site-title lh-tight">
  <div class="site-logo" role="img" aria-hidden="true"></div>

<span class="site-title-text">ReliefWeb API Docs</span>
</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Read / search category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/read/" class="nav-list-link">Read / search</a><ul class="nav-list"><li class="nav-list-item"><a href="/read/search/" class="nav-list-link">Search</a></li><li class="nav-list-item"><a href="/read/filtering/" class="nav-list-link">Filter</a></li><li class="nav-list-item"><a href="/read/fields-and-presets/" class="nav-list-link">Choose fields</a></li><li class="nav-list-item"><a href="/read/sorting-and-pagination/" class="nav-list-link">Sort and paginate</a></li><li class="nav-list-item"><a href="/read/facets/" class="nav-list-link">Break down results</a></li><li class="nav-list-item"><a href="/read/get-item/" class="nav-list-link">Get one item</a></li><li class="nav-list-item"><a href="/read/get-vs-post/" class="nav-list-link">GET vs POST</a></li><li class="nav-list-item"><a href="/read/response/" class="nav-list-link">Response, limits, and errors</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Resources category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/read/resources/" class="nav-list-link">Resources</a><ul class="nav-list"><li class="nav-list-item"><a href="/read/resources/reports/" class="nav-list-link">Reports</a></li><li class="nav-list-item"><a href="/read/resources/disasters/" class="nav-list-link">Disasters</a></li><li class="nav-list-item"><a href="/read/resources/countries/" class="nav-list-link">Countries</a></li><li class="nav-list-item"><a href="/read/resources/jobs/" class="nav-list-link">Jobs</a></li><li class="nav-list-item"><a href="/read/resources/training/" class="nav-list-link">Training</a></li><li class="nav-list-item"><a href="/read/resources/sources/" class="nav-list-link">Sources</a></li><li class="nav-list-item"><a href="/read/resources/blog/" class="nav-list-link">Blog</a></li><li class="nav-list-item"><a href="/read/resources/topics/" class="nav-list-link">Topics</a></li><li class="nav-list-item"><a href="/read/resources/references/" class="nav-list-link">References</a></li><li class="nav-list-item"><a href="/read/resources/field-catalogue/" class="nav-list-link">Field catalogue</a></li></ul></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Publish category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/publish/" class="nav-list-link">Publish</a><ul class="nav-list"><li class="nav-list-item"><a href="/publish/credentials/" class="nav-list-link">Access and credentials</a></li><li class="nav-list-item"><a href="/publish/urls-and-uuids/" class="nav-list-link">Trusted URLs and UUIDs</a></li><li class="nav-list-item"><a href="/publish/create/" class="nav-list-link">Create</a></li><li class="nav-list-item"><a href="/publish/update/" class="nav-list-link">Update</a></li><li class="nav-list-item"><a href="/publish/withdraw/" class="nav-list-link">Withdraw</a></li><li class="nav-list-item"><a href="/publish/methods-and-responses/" class="nav-list-link">Responses, limits, and errors</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Reports category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/publish/reports/" class="nav-list-link">Reports</a><ul class="nav-list"><li class="nav-list-item"><a href="/publish/reports/fields/" class="nav-list-link">Report fields</a></li><li class="nav-list-item"><a href="/publish/files-and-images/" class="nav-list-link">Files and images</a></li><li class="nav-list-item"><a href="/publish/reports/examples/" class="nav-list-link">Report examples</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Jobs category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/publish/jobs/" class="nav-list-link">Jobs</a><ul class="nav-list"><li class="nav-list-item"><a href="/publish/jobs/fields/" class="nav-list-link">Job fields</a></li><li class="nav-list-item"><a href="/publish/jobs/examples/" class="nav-list-link">Job examples</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Training category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/publish/training/" class="nav-list-link">Training</a><ul class="nav-list"><li class="nav-list-item"><a href="/publish/training/fields/" class="nav-list-link">Training fields</a></li><li class="nav-list-item"><a href="/publish/training/examples/" class="nav-list-link">Training examples</a></li></ul></li></ul></li><li class="nav-list-item"><a href="/faq/" class="nav-list-link">FAQ</a></li></ul>
  
</nav>




  
  
    <span></span>

  
</div>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search ReliefWeb API Documentation" aria-label="Search ReliefWeb API Documentation" autocomplete="off">
    <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  
  
    <nav aria-label="Auxiliary" class="aux-nav">
  <ul class="aux-nav-list">
    
      <li class="aux-nav-list-item">
        <a href="https://api.reliefweb.int/v2/swagger/api" class="site-button"
          
          target="_blank" rel="noopener noreferrer"
          
        >
          OpenAPI
        </a>
      </li>
    
  </ul>
</nav>

  
</div>

    <div class="main-content-wrap">
      
      <div id="main-content" class="main-content">
        <main>
          
            

          

          
            
          
        </main>
        

  <hr>
  <footer>
    

    <!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M4X6LPS"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->
<div class="site-footer-row text-small text-grey-dk-100">
  <span>A service of <a href="https://reliefweb.int">ReliefWeb</a> / <a href="https://www.unocha.org/">UN OCHA</a>.</span>
  <span>Powered by <a href="https://just-the-docs.com">Just the Docs</a>.</span>
</div>


    
  </footer>


      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

