Humanitarianresponse Logo

API is short for ‘application programming interface,’ which provide a read-only access to extract both content and standard taxonomy from so that the developers community can consume such data and produce custom information products and tools which could be specific to their needs.

The following table lists all the available APIs along with examples to demonstrate how to request the data. The data returned from those APIs is available in JSON format. To view the data returned by the APIs, we advise you to use the JSONView plugin in your browser.

Entry point for APIs

The main path to the API is which lists all the APIs through which the data from the platform can be exposed.

Item Type Description Examples
Clusters/Sectors (bundles) content

Clusters, sectors or working groups in are treated as bundles. Using the APIs, once can get all the active cluster or sector in operation or country office.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

All active clusters and sectors in the current emergency operations;
To get active sectors in all emergency operations;
Disaster/Glide numbers taxonomy List all the disasters with the glide numbers fom platform. In the API we are also pulling the disaster 'ID' as primary key from ReliefWeb
List all the glide numbers for ‘current’ disasters
Documents content

Extract the documents such as reports, SRP, HNOs and other types from any spaces in the platform

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

List all documents form 
Get all the documents tagged as HNOs -‘Humanitarian Needs overview' from
Get all the documents of documnet type 'Newsletter' for Philippines operation[operatio...
Document Types content The content type documents uploaded by various operations offices such as situation reports, fact sheets, planning, etc. are available via APIs.

Get all the documents tagged as ‘Strategic Response Plan’ in;
Get all the Situation reports for Sudan operation;
Events/Calendar content

Extract the calendar events from for a given operation and applying date filters.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

Get the events for the operation ‘Central African Republic’

Get the list of meetings between Dec, 2014 and Jan 2015 for operation/country Pakistan;[operation]=...

Functional Role taxonomy Functional roles are defined as taxonomy in platform. Based on those roles, groups such as IM working groups or GIS working groups can be formed in operation.
Global Clusters taxonomy All the global standard clusters names with standard 3 letter cluster codes are available from the API

Infographic Types taxonomy Type of maps and infographics such as 3W, Operational presence, Funding graph, Hazard Maps, etc. These terms are defined as standard taxonomy in platform.
Maps/Infographics content

List visual products i.e. Maps, Infographics and dashboard uploaded by operational websites.

Note: 'created' and 'changed' date fields provided by default with Drupal and they are stored as UNIX timestamps.

Extract 3W maps form all the operational websites[infog...

List all the Humanitarian Dashboards for Afghanistan operation[infog...
Locations taxonomy

All geographic locations i.e. country names, 2-letters country code (ISO) as Pcode, coordinates (Lat, Long) and administrative levels are available via this API.

All these locations are added as taxonomy in platform after importing the country specific CODs.

To get first administrative level i.e. ‘list of provinces’ for Afghanistan, use filters; for admin level 1 use “[admin_level]” and for country use “[parent]” id;
Offices content Offices are Coordination hubs within in operation/country offices and available in the platform as content type.
Operations content Operations are country or regional offices websites setup as sub-sites within in platform. For example, the interactive map in is built using the operations API data. "HID Access" refers to whether HID has opened a list based on the operation. "Status" refers to whether users can view uploaded content for an operation.

Get the list of all active [status set to active in the parameter] regional operations from
Organizations taxonomy

Organizations are defined as taxonomy in platform.

To find organization by acronym e.g.SIDA;
To find organization by FTS IDID;
To get the list of donors use the filter “[type]”;
Organization Types taxonomy All organization types, e.g. UN, local NGO, Donors, etc.

Population Types taxonomy Population type, such as children, affected population, women, men, host communities, etc. These terms are defined as standard taxonomy in platform.

To find population type ‘Refugees’;
Spaces content Spaces are the subsites within platform and those are available for global websites such as Gender, Gencap/ProCap, HPC, and Cross cutting issues etc.

To find the global space ‘Humanitarian Programme Cycle’;
Themes taxonomy All thematic areas such as Gender, Field coordination, Resilience, Governance, etc. that we use to tag content are defined as taxonomy in platform.

Advance API Parameters

Using page parameters, the API will return the specific page in a list query.
Example: will return data from the second page.
Allows you to filter by specific fields and return results from the list query that match the exact condition of the filter.
Example: List all the documents tagged as ‘Strategic Response Plan’ by applying the filter ‘document_type’.[document_type]=49537
Note: Always put the filter value in brackets (e.g. [document_type])
You can also add an operator to the filter argument. For example, to get all documents published after Jan 1, 2015:[publication_date][value]=2015-01-01&filter[publication_date][operator]=”>="
Sort the data returned from the API. To sort the given field in the list in descending order use ahyphen i.e. ‘-’
Example; Sort the organization name ‘label’ in descending order,
Allows you to set which fields should be returned in the results.
Example: Get the organization name and acronym from the Organization API,,acronym
Allows you to set how many items you need to return from the list query
Example: Get names and acronym from the query list for only five organizations,acronym
Allows you to retrieve results based on an autocomplete string.
Example: Get all organizations which name starts with “United”:[string]=United&autocomplete[operator]=STARTS_WITH
Example: Get all organizations which name contains the word “United”:[string]=United&autocomplete[operator]=CONTAINS

Example of successful API request listing three global clusters:

label: "Camp Coordination / Management",
acronym: "CCM",
homepage: ""
label: "Early Recovery",
acronym: "ERY",
homepage: ""
label: "Education",
acronym: "EDU",
homepage: ""
count: 15,
title: "Self",
href: ""
title: "Next",
href: ""

If you have any questions about the APIs, get in touch with us at