Countries

Country records and situational overviews (reliefweb.int/countries), including id, name, shortname, iso3, status, and country profile content.

Query /v2/countries to look up country id or iso3 codes for filtering or publishing on other resources.

  • Endpoint: POST or GET https://api.reliefweb.int/v2/countries
  • Single country: GET https://api.reliefweb.int/v2/countries/{id|uuid}

Defaults

Requests to /v2/countries default to profile=minimal and preset=minimal. Single-record requests (/v2/countries/{id}) default to profile=default and preset=minimal. See Choose fields and presets.

Profiles

ProfileFields
minimal name
list name, status, url
suggest name, shortname (sets slim)
full All fields
default All fields (omits profile.key_content.archive, profile.appeals_response_plans.archive)

Add more with fields.include (for example iso3 is not in list).

Presets

PresetStatus filterSortDefault query fields
minimal n/a n/a name
latest n/a id:desc name, shortname, iso3
analysis n/a n/a name, shortname, iso3, status

Available fields

NameDescriptionTypeAttributes
current Deprecated boolean sortable facetable
date Shortcut for date - defaults to date.created object facetable
date.changed Date entry modified on ReliefWeb (ISO 8601) date sortable facetable
date.created Date entry created on ReliefWeb (ISO 8601) date sortable facetable
description Description of the country in Markdown format string searchable
description-html Description of the country in HTML format string
featured Flag to indicate if the country is featured on ReliefWeb home page boolean sortable facetable
id Unique id of country used by ReliefWeb integer searchable sortable
iso3 ISO 3166-1 alpha-3 code string searchable sortable exact
name Name of country in English string searchable sortable exact
name.collation_en Name field for English collation-aware sorting string sortable
profile defaults to profile.overview string searchable
profile.appeals_response_plans Appeals and Response Plans for this country array
profile.appeals_response_plans.active Array of links for current appeals and plans array multi
profile.appeals_response_plans.active.image Current appeal or plan image string
profile.appeals_response_plans.active.title Current appeal or plan title string
profile.appeals_response_plans.active.url Current appeal or plan url string
profile.appeals_response_plans.archive Array of links for archive appeals and plans array multi
profile.appeals_response_plans.archive.image Archive appeal or plan image string
profile.appeals_response_plans.archive.title Archive appeal or plan title string
profile.appeals_response_plans.archive.url Archive appeal or plan url string
profile.appeals_response_plans.title "Appeals & Response Plans" string
profile.key_content Latest situation reports and analysis array
profile.key_content.active Array of links for current key content for the country array multi
profile.key_content.active.image Current key content link image string
profile.key_content.active.title Current key content link title string
profile.key_content.active.url Current key content link url string
profile.key_content.archive Array of links for archive key content for the country array multi
profile.key_content.archive.image Archive key content link image string
profile.key_content.archive.title Archive key content link title string
profile.key_content.archive.url Archive key content link url string
profile.key_content.title "Key Content" string
profile.overview Profile of the country in Markdown format string searchable
profile.overview-html Profile of the country in HTML format string
profile.useful_links Useful links to external sites array
profile.useful_links.active Array of useful links array multi
profile.useful_links.active.image Useful link image string
profile.useful_links.active.title Useful link title string
profile.useful_links.active.url Useful link url string
profile.useful_links.title "Useful links" string
redirects Previous URL aliases that redirect to this item string searchable
shortname Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic' string searchable sortable exact
shortname.collation_en Short name field for English collation-aware sorting string sortable
status Whether country has an active situation string searchable facetable
url Canonical url string
url_alias Friendly' url of the country string searchable
uuid UUID of the document or term string searchable