ReliefWeb API Fields tables

Introduction

Use tabs to see lists of fields by content type.The summary tab shows all fields with links to the content types they are used in. The other tabs show the names of fields with a short description, its type, and the abbreviations used in advanced searches on ReliefWeb.

For advanced use, the attributes column shows whether a field can be used for search - in a query or a filter - sorts and facets or with the "exact" qualifier. Multi means a returned field can have mulitple values (objects) like country or theme. common fields make it easier to search. For example, source.common contains both the full name and the short name of the source, so both "OCHA" and "Office for the Coordination of Humanitarian Affairs" will return the same result. ".common" fields often have an ".exact" version too.

Note: In the field descriptions in this table, fields that have subfields are often described as defaulting to one of those subfields. This refers to a search, and not the result. So, for example, a query[fields][]=country is equivalent to query[fields][]=country.name. The result will return JSON objects for each country, not only the names.

The tables

Summary Blog Book Countries Disasters Jobs Reports Sources Training

Name	Type	Abbreviation	Content Types
body	string		reports, jobs, training
body-html	string		reports, jobs, training
career_categories	array		jobs, training
career_categories .id	integer	CC	jobs, training
career_categories .name	string		jobs, training
city	array		jobs, training
city.name	string		jobs, training
content_type	array		sources
country	array		reports, jobs, training, disasters, sources
country.id	integer	C	reports, jobs, training, disasters, sources
country.iso3	string		reports, jobs, training, disasters, sources
country.name	string		reports, jobs, training, disasters, sources
country.primary	boolean		reports, jobs, training, disasters, sources
country.shortname	string		reports, jobs, training, disasters, sources
cost	string		training
current	boolean		countries, disasters
date	object		reports, jobs, disasters
date.changed	date		reports, jobs, training, countries, disasters, sources
date.closing	date	DC	jobs
date.created	date	DA	reports, jobs, training, countries, disasters, sources
date.end	date	DE	training
date.event	date		disasters
date.original	date	DO	reports
date.registration	date	DR	training
date.start	date	DS	training
description	string		countries, disasters, sources
description-html	string		countries, disasters, sources
disaster	array		reports
disaster.id	integer	D	reports
disaster.name	string		reports
disaster.glide	string		reports
disaster.type	array		reports
disaster.type.code	string		reports
disaster.type.id	integer		reports
disaster.type.name	string		reports
disaster.type.primary	boolean		reports
disaster_type	string		reports
disaster_type.code	array		reports
disaster_type.id	integer	DT	reports
disaster_type.name	string		reports
disclaimer	string		sources
experience	array		jobs
experience.id	integer	E	jobs
experience.name	string		jobs
feature	array		reports
feature.id	integer		reports
feature.name	string		reports
featured	boolean		countries, disasters
file	array		reports, jobs, training
file.description	string		reports, jobs, training
file.filename	string		reports, jobs, training
file.id	integer		reports, jobs, training
file.mimetype	string		reports, jobs, training
file.preview	array		reports
file.preview .url	string		reports
file.preview .url-large	string		reports
file.preview .url-small	string		reports
file.preview .url-thumb	string		reports
file.url	string		reports, jobs, training
format	array		reports, training
format.id	integer	F	reports, training
format.name	string		reports, training
fts_id	integer		sources
glide	string		disasters
headline	array		reports
headline.featured	string		reports
headline.image	array		reports
headline.image .caption	string		reports
headline.image .copyright	string		reports
headline.image .filename	string		reports
headline.image .id	integer		reports
headline.image .mimetype	string		reports
headline.image .url	string		reports
headline.summary	string		reports
headline.title	string		reports
homepage	string		sources
how_to_apply	string		jobs
how_to_apply-html	string		jobs
how_to_register	string		training
how_to_register-html	string		training
id	integer		reports, jobs, training, countries, disasters, sources
image	array		reports
image.caption	string		reports
image.copyright	string		reports
image.filename	string		reports
image.id	integer		reports
image.mimetype	string		reports
image.url	string		reports
image.url-large	string		reports
image.url-small	string		reports
image.url-thumb	string		reports
iso3	string		countries
language	array		reports, training
language.code	string		reports, training
language.id	integer	L	reports, training
language.name	string		reports, training
longname	string		sources
name	string		countries, disasters, sources
ocha_product	array		reports
ocha_product.id	integer		reports
ocha_product.name	string		reports
origin	string		reports
primary_country	array		reports, disasters
primary_country .id	integer	PC	reports, disasters
primary_country .iso3	string		reports, disasters
primary_country .name	string		reports, disasters
primary_country .shortname	string		reports, disasters
primary_type	array		disasters
primary_type.id	integer	TY	disasters
primary_type.name	string		disasters
profile	string		countries, disasters
profile.overview	string		countries, disasters
profile.overview-html	string		countries, disasters
profile.key_content	array		countries, disasters
profile.key_content .title	string		countries, disasters
profile.key_content .active	array		countries, disasters
profile.key_content .active.url	string		countries, disasters
profile.key_content .active.title	string		countries, disasters
profile.key_content .active.image	string		countries, disasters
profile.key_content .archive	array		countries, disasters
profile.key_content .archive.url	string		countries, disasters
profile.key_content .archive.title	string		countries, disasters
profile.key_content .archive.image	string		countries, disasters
profile .appeals_response_plans	array		countries, disasters
profile .appeals_response_plans.title	string		countries, disasters
profile .appeals_response_plans.active	array		countries, disasters
profile .appeals_response_plans.active.url	string		countries, disasters
profile .appeals_response_plans.active.title	string		countries, disasters
profile .appeals_response_plans.active.image	string		countries, disasters
profile .appeals_response_plans.archive	array		countries, disasters
profile .appeals_response_plans.archive.url	string		countries, disasters
profile .appeals_response_plans.archive.title	string		countries, disasters
profile .appeals_response_plans.archive.image	string		countries, disasters
profile.useful_links	array		countries, disasters
profile.useful_links .title	string		countries, disasters
profile.useful_links .active	array		countries, disasters
profile.useful_links .active.url	string		countries, disasters
profile.useful_links .active.title	string		countries, disasters
profile.useful_links .active.image	string		countries, disasters
related_glide	array		disasters
shortname	string		countries, sources
source	array		reports, jobs, training
source.disclaimer	string		sources
source.homepage	string		reports, jobs, training
source.id	integer	S	reports, jobs, training
source.longname	string		reports, jobs, training
source.name	string		reports, jobs, training
source.shortname	string		reports, jobs, training
source.spanish_name	string		reports, jobs, training
source.type	array		reports, jobs, training
source.type.id	integer	ST	reports, jobs, training
source.type.name	string		reports, jobs, training
spanish_name	string		sources
status	string		reports, jobs, training, countries, sources
theme	array		reports, jobs, training
theme.id	integer	T	reports, jobs, training
theme.name	string		reports, jobs, training
title	string		reports, jobs, training
training_language	string		training
training_language.id	integer	TL	training
training_language.name	string		training
training_language.code	string		training
type	array		jobs, training, disasters, sources
type.code	string		disasters
type.id	integer	TY	jobs, training, disasters, sources
type.name	string		jobs, training, disasters, sources
type.primary	boolean		disasters
url	string		reports, jobs, training, countries, disasters, sources
url_alias	string		reports, jobs, training, countries, disasters, sources

Name	Description	Type	Attributes	Abbreviation
body	Main text in Markdown format	string	searchable
body-html	Main text in HTML format	string
country	Shortcut for country - defaults to country.name	string	searchable facetable exact multi common
country.id	Id for country used by ReliefWeb	integer	searchable facetable exact	C
country.iso3	ISO 3166-1 alpha-3 code	string	searchable facetable exact
country.name	Name of country in English	string	searchable facetable exact
country.primary	Flag to indicate this is the primary country	boolean
country.shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	searchable facetable exact
date	Shortcut for date fields - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
date.original	Date entry first published by original source (ISO 8601)	date	sortable facetable	DO
disaster	Shortcut for related disaster - defaults to disaster.name	string	searchable facetable exact multi common
disaster.id	Id for related disaster used by ReliefWeb	integer	searchable facetable	D
disaster.name	Name assigned to the disaster based on the ReliefWeb disaster naming convention	string	searchable facetable exact
disaster.glide	Global IDEntifier number (GLIDE) of the disaster	string	searchable facetable
disaster.type	Disaster type of the associated disaster. Note this may be different to the `disaster_type` of a report. Defaults to disaster.type.name	string	searchable facetable exact multi common
disaster.type.code	Code for the disaster type of the associated disaster.	string	searchable facetable
disaster.type.id	Id for the disaster type of the associated disaster.	integer	searchable facetable
disaster.type.name	Link for values	string	searchable facetable exact
disaster.type.primary	Whether this is the primary disaster type for the associated disaster.	boolean
disaster_type	Shortcut for disaster type - defaults to disaster_type.name	string	searchable facetable exact multi common
disaster_type.id	Id for disaster type used by ReliefWeb	integer	searchable facetable	DT
disaster_type.name	Link for values	string	searchable facetable exact
disaster_type.code	GLIDE hazard code for disaster type.	string	searchable facetable
feature	defaults to feature.name	string	searchable facetable exact multi common
feature.id	Id for feature used by ReliefWeb	integer	searchable facetable
feature.name	Link for values.	string	searchable facetable exact
file	File attachment shortcut - defaults to file.id	array	multi
file.description	Description of file attachment	string	searchable
file.filename	File name of file attachment	string
file.id	Id of file attachment used by ReliefWeb	integer	searchable
file.mimetype	MIME type of file attachment	string
file.preview	Shortcut for preview image of file attachment - defaults to file.preview.url	array	multi
file.preview .url	Link to preview image of file attachment	string
file.preview .url-large	Link to a large preview image with a width of 680px	string
file.preview .url-small	Link to a small preview image with a width of 200px	string
file.preview .url-thumb	Link to a thumbnail preview image with a maximum width of 220px and a maximum height of 100px	string
file.url	Link to file attachment	string
format	Shortcut for content format - defaults to format.name	string	searchable facetable exact multi common
format.id	Id of content format used by ReliefWeb	integer	searchable facetable	F
format.name	Link for values	string	searchable facetable exact
headline	Shortcut for headline - defaults to headline.title	array
headline.featured		string	sortable searchable facetable
headline.image	Shortcut for headline image - defaults to headline.image.id	array
headline.image .id	Unique id of headline image used by ReliefWeb	integer	searchable
headline.image .mimetype	MIME type of the headline image	string
headline.image .filename	File name of the headline image	string
headline.image .caption	Caption attached to the headline image	string	searchable
headline.image .copyright	Copyright attached to the headline image	string	searchable
headline.image .url	URL of the headline image	string
headline.summary	Summary of body, if report is selected as headline. Typically 180-190 characters long	string	searchable
headline.title	Headline text, if report is selected as headline. Typically 100-120 characters long	string	sortable searchable
id	Unique id of report used by ReliefWeb	integer	sortable searchable
image	Image shortcut - defaults to image.id	integer
image.caption	Caption attached to the image	string	searchable
image.copyright	Copyright attached to the image	string	searchable
image.id	Unique id of image used by ReliefWeb	integer	searchable
image.mimetype	MIME type of the image	string
image.filename	File name of the image	string
image.url	Link to the original image	string
image.url-large	Link to a large image with a width of 680px	string
image.url-small	Link to a small image with a width of 200px	string
image.url-thumb	Link to a thumbnail image with a maximum width of 220px and a maximum height of 100px	string
language	Shortcut for language - defaults to language.name	string	searchable facetable exact multi common
language.code	ISO 639-1 code of the language the entry is written in	string	searchable facetable
language.id	Id for language of report used by ReliefWeb	integer	facetable	L
language.name	Language the report is written in - Link for values.	string	searchable facetable exact
ocha_product	Shortcut for OCHA product - defaults to ocha_product.name	string	searchable facetable exact multi common
ocha_product.id	Id of OCHA product used by ReliefWeb	integer	searchable facetable
ocha_product.name	Link for values	string	searchable facetable exact
origin	Url of original report when it was added to ReliefWeb	string
primary_country	Shortcut for primary country - defaults to primary_country.name	string	searchable facetable exact multi common
primary_country .id	Id of primary country used by ReliefWeb	integer	sortable searchable facetable	PC
primary_country .name	Link for more information	string	sortable searchable facetable exact
primary_country .shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	sortable searchable facetable exact
primary_country .iso3	ISO 3166-1 alpha-3 code	string	sortable searchable facetable exact
source	Shortcut for sources - defaults to source.name	string	searchable facetable exact multi common
source.disclaimer	Disclaimer information for the source	string	searchable
source.id	Id for source used by ReliefWeb	integer	searchable facetable	S
source.name	Common name of source	string	searchable facetable exact
source.longname	Official name of the source if different from source.name	string	searchable facetable exact
source.homepage	URL of the source's primary website	string	searchable
source.shortname	Short name of the source, typically an acronym e.g. UNICEF	string	searchable facetable exact
source.spanish_name	Spanish name of the source	string	searchable facetable exact
source.type	Shortcut for source type - defaults to source.type.name	array
source.type.id	Id for source type used by ReliefWeb	integer	searchable facetable	ST
source.type.name	Link for values	string	searchable facetable exact
status		string	searchable facetable
theme	Shortcut for theme - defaults to theme.name	string	searchable facetable exact multi common
theme.id	Id of theme used by ReliefWeb	integer	searchable facetable	T
theme.name	Link for values	string	searchable facetable exact
title	Title of report	string	sortable searchable exact
url	Canonical url	string
url_alias	Friendly' url of the report	string	searchable

Name	Description	Type	Attributes	Abbreviation
country	Shortcut for country - defaults to country.name	string	searchable facetable exact multi common
country.id	Id for country used by ReliefWeb	integer	searchable facetable	C
country.iso3	ISO 3166-1 alpha-3 code	string	searchable facetable exact
country.primary	Flag to indicate this is the primary country	boolean
country.name	Name of country in English	string	searchable facetable exact
country.shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	searchable facetable exact
current	Deprecated	boolean	sortable facetable
date	Shortcut for date - defaults to date.created	object	searchable 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	DA
date.event	Date when the disaster occurred (ISO 8601)	date	sortable facetable
description	Description of the disaster in Markdown format	string	searchable
description-html	Description of the disaster in HTML format	string
featured	Flag to indicate if the disaster is featured on ReliefWeb home page	boolean	sortable facetable
glide	Global IDEntifier number (GLIDE) of the disaster	string	sortable searchable exact
id	Unique id of disaster used by ReliefWeb	integer	sortable searchable
name		string	sortable searchable exact
primary_country	Shortcut for primary country - defaults to primary_country.name	string	searchable facetable exact multi common
primary_country .id	Id of primary country used by ReliefWeb	integer	sortable searchable facetable
primary_country .iso3	ISO 3166-1 alpha-3 code	string	sortable searchable facetable exact
primary_country .name	Link for more information	string	sortable searchable facetable exact
primary_country .shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	sortable searchable facetable exact
primary_type	Shortcut for primary disaster type - defaults to primary_type.name	string	searchable facetable exact multi common
primary_type.id	Id for primary disaster type used by ReliefWeb	integer	searchable facetable
primary_type.name	Name of primary disaster type	string	searchable facetable exact
profile	defaults to profile.overview	string	searchable
profile.overview	Profile of the country in Markdown format	string	searchable
profile.overview-html	Profile of the country in HTML format	string
profile.key_content	Latest situation reports and analysis	array
profile.key_content .title	"Key Content"	string
profile.key_content .active	Array of links for current key content for the country	array
profile.key_content .active.url	Current key content link url	string
profile.key_content .active.title	Current key content link title	string
profile.key_content .active.image	Current key content link image	string
profile.key_content .archive	Array of links for archive key content for the country	array
profile.key_content .archive.url	Archive key content link url	string
profile.key_content .archive.title	Archive key content link title	string
profile.key_content .archive.image	Archive key content link image	string
profile .appeals_response_plans	Appeals and Response Plans for this country	array
profile .appeals_response_plans.title	"Appeals & Response Plans"	string
profile .appeals_response_plans.active	Array of links for current appeals and plans	array
profile .appeals_response_plans.active.url	Current appeal or plan url	string
profile .appeals_response_plans.active.title	Current appeal or plan title	string
profile .appeals_response_plans.active.image	Current appeal or plan image	string
profile .appeals_response_plans.archive	Array of links for archive appeals and plans	array
profile .appeals_response_plans.archive.url	Archive appeal or plan url	string
profile .appeals_response_plans.archive.title	Archive appeal or plan title	string
profile .appeals_response_plans.archive.image	Archive appeal or plan image	string
profile.useful_links	Useful links to external sites	array
profile.useful_links .title	"Useful links"	string
profile.useful_links .active	Array of useful links	array
profile.useful_links .active.url	Useful link url	string
profile.useful_links .active.title	Useful link title	string
profile.useful_links .active.image	Useful link image	string
related_glide	Related Global IDEntifier number (GLIDE)	array	searchable exact
status	current', 'alert', 'past'	string	searchable facetable
type	Shortcut for disaster type - defaults to type.name	string	searchable facetable exact multi common
type.code	Code of disaster type	string	sortable searchable facetable
type.id	Id of disaster type used by ReliefWeb	integer	searchable facetable	DT
type.name	Link for values	string	searchable facetable exact
type.primary	Whether disaster type is primary or not	boolean
url	Canonical url	string
url_alias	Friendly' url of the disaster	string	searchable

Name	Description	Type	Attributes	Abbreviation
current	Deprecated	boolean	sortable facetable
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
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	sortable searchable
iso3	ISO 3166-1 alpha-3 code	string	sortable searchable exact
name	Country name in English	string	sortable searchable exact
profile	defaults to profile.overview	string	searchable
profile.overview	Profile of the country in Markdown format	string	searchable
profile.overview-html	Profile of the country in HTML format	string
profile.key_content	Latest situation reports and analysis	array
profile.key_content .title	"Key Content"	string
profile.key_content .active	Array of links for current key content for the country	array	multi
profile.key_content .active.url	Current key content link url	string
profile.key_content .active.title	Current key content link title	string
profile.key_content .active.image	Current key content link image	string
profile.key_content .archive	Array of links for archive key content for the country	array	multi
profile.key_content .archive.url	Archive key content link url	string
profile.key_content .archive.title	Archive key content link title	string
profile.key_content .archive.image	Archive key content link image	string
profile .appeals_response_plans	Appeals and Response Plans for this country	array
profile .appeals_response_plans.title	"Appeals & Response Plans"	string
profile .appeals_response_plans.active	Array of links for current appeals and plans	array	multi
profile .appeals_response_plans.active.url	Current appeal or plan url	string
profile .appeals_response_plans.active.title	Current appeal or plan title	string
profile .appeals_response_plans.active.image	Current appeal or plan image	string
profile .appeals_response_plans.archive	Array of links for archive appeals and plans	array	multi
profile .appeals_response_plans.archive.url	Archive appeal or plan url	string
profile .appeals_response_plans.archive.title	Archive appeal or plan title	string
profile .appeals_response_plans.archive.image	Archive appeal or plan image	string
profile.useful_links	Useful links to external sites	array
profile.useful_links .title	"Useful links"	string
profile.useful_links .active	Array of useful links	array	multi
profile.useful_links .active.url	Useful link url	string
profile.useful_links .active.title	Useful link title	string
profile.useful_links .active.image	Useful link image	string
shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	sortable searchable exact
status	Whether country has an active situation	string	searchable facetable
url	Canonical url	string
url_alias	Friendly' url of the country	string	searchable

Name	Description	Type	Attributes	Abbreviation
body	Description of job in Markdown format	string	searchable
body-html	Description of job in HTML format	string
career_categories	Shortcut for career categories - defaults to career_categories.name	string	searchable facetable exact multi common
career_categories .id	Id for career categories used by ReliefWeb	integer	searchable facetable	CC
career_categories .name	Link for values	string	searchable facetable exact
city	Shortcut for city - defaults to city.name	string	searchable facetable exact multi common
city.name	Name of city in English	string	searchable facetable exact
country	Shortcut for country - defaults to country.name	string	searchable facetable exact multi common
country.id	Id for country used by ReliefWeb	integer	searchable facetable	C
country.primary	Flag to indicate this is the primary country	boolean
country.name	Name of country in English	string	searchable facetable exact
country.shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	searchable facetable exact
country.iso3	ISO 3166-1 alpha-3 code	string	searchable facetable exact
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.closing	Date job closes to applicants (ISO 8601)	date	sortable facetable	DC
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
experience	Shortcut for experience requirement - defaults to experience.name	string	searchable facetable exact multi common
experience.id	Id for experience requirement used by ReliefWeb	integer	searchable facetable	E
experience.name	Link for values.	string	searchable facetable exact
file	Shortcut for file attachment - defaults to file.id	array	multi
file.description	Description of the file attachment	string	searchable
file.filename	File name of the attachment	string
file.id	Id for file attachment used by ReliefWeb	integer	searchable
file.mimetype	MIME type of the file attachment	string
file.url	URL of the file attachment	string
how_to_apply	Application instructions for the job in Markdown format	string	searchable
how_to_apply-html	Application instructions for the job in HTML format	string
id	Unique id of job used by ReliefWeb	integer	sortable searchable
source	Shortcut for source - defaults to source.name	string	searchable facetable exact multi common
source.homepage	URL of the source's primary website	string	searchable
source.id	Id for source used by ReliefWeb	integer	searchable facetable exact	S
source.longname	Official name of the source if different from source.name	string	searchable facetable exact
source.name	Common name of source	string	searchable facetable exact
source.shortname	Short name of the source, typically an acronym e.g. UNICEF	string	searchable facetable exact
source.spanish_name	Spanish name of the source	string	searchable facetable exact
source.type	Shortcut for source type - defaults to source.type.name	array
source.type.id	Id for source type used by ReliefWeb	integer	searchable facetable	ST
source.type.name	Link for values	string	searchable facetable exact
status	Whether job is still current	string	searchable facetable
theme	Shortcut for theme - defaults to theme.name	string	searchable facetable exact multi common
theme.id	Id for theme used by ReliefWeb	integer	searchable facetable	T
theme.name	Link for values	string	searchable facetable exact
title	Job title	string	sortable searchable exact
type	Shortcut for type - defaults to type.name	string	searchable facetable exact multi common
type.id	Id for job type used by ReliefWeb	integer	searchable facetable	TY
type.name	Link for values	string	searchable facetable exact
url	Canonical url	string
url_alias	Friendly' url of the job	string	searchable

Name	Description	Type	Attributes	Abbreviation
body	Training description in Markdown format	string	searchable
body-html	Training description in HTML format	string
career_categories	Shortcut for career categories - defaults to career_categories.name	string	searchable facetable exact multi common
career_categories .id	Id for career categories used by ReliefWeb	integer	searchable facetable	CC
career_categories .name	Link for values	string	searchable facetable exact
city	Shortcut for city - defaults to city.name	string	searchable facetable exact multi common
city.name	Name of city in English	string	searchable facetable exact
cost	`free` or `fee-based`	string	searchable facetable
country	Shortcut for country - defaults to country.name	string	searchable facetable exact multi common
country.id	Id for country used by ReliefWeb	integer	searchable facetable	C
country.iso3	ISO 3166-1 alpha-3 code	string	searchable facetable exact
country.name	Name of country in English	string	searchable facetable exact
country.primary	Flag to indicate this is the primary country	boolean
country.shortname	Short name of country where applicable, for example 'Syria' for 'Syrian Arab Republic'	string	searchable facetable exact
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
date.end	Date training ends (ISO 8601)	date	sortable facetable	DE
date.registration	Date registration closes (ISO 8601)	date	sortable facetable	DR
date.start	Date training starts (ISO 8601)	date	sortable facetable	DS
file	Shortcut for file attachment - defaults to file.id	array	multi
file.description	Description of the file attachment	string	searchable
file.filename	File name of the attachment	string
file.id	Id for file attachment used by ReliefWeb	integer	searchable
file.mimetype	MIME type of the file attachment	string
file.url	URL of the file attachment	string
format	Shortcut for training format - defaults to format.name	string	searchable facetable exact multi common
format.id	Id for training format used by ReliefWeb	integer	searchable facetable	F
format.name	Link to values	string	searchable facetable exact
how_to_register	Registration information in Markdown format	string	searchable
how_to_register -html	Registration information in HTML format	string
id	Unique id for training opportunity used by ReliefWeb	integer	sortable searchable
language	Shortcut for language - defaults to language.name	string	searchable facetable exact multi common
language.code	ISO 639-1 code of the language the entry is written in	string	searchable facetable exact
language.id	Id for language used by ReliefWeb	integer	facetable	L
language.name	Language in which post is written (not necessarily language in which the training will be held). Link for values.	string	searchable facetable exact
source	Shortcut for source - defaults to source.name	string	searchable facetable exact multi common
source.id	Id for source used by ReliefWeb	integer	searchable facetable	S
source.name	Common name of source	string	searchable facetable exact
source.longname	Official name of the source if different from source.name	string	searchable facetable exact
source.homepage	URL of the source's primary website	string	searchable
source.shortname	Short name of the source, typically an acronym e.g. UNICEF	string	searchable facetable exact
source.spanish_name	Spanish name of the source	string	searchable facetable exact
source.type	Shortcut for source type - defaults to source.type.name	array
source.type.id	Id for source type used by ReliefWeb	integer	searchable facetable	ST
source.type.name	Link for values	string	searchable facetable exact
status	Whether training is still current	string	searchable facetable
theme	Shortcut for theme - defaults to theme.name	string	searchable facetable exact multi common
theme.id	Id for theme used by ReliefWeb	integer	searchable facetable	T
theme.name	Link for values	string	searchable facetable exact
title	Title of course	string	sortable searchable exact
training_language	Language training is held in, defaults to training_language.name	string	searchable facetable exact multi common
training_language.id	Id of language training is held in	integer	facetable	TL
training_language.name	Name of language training is held in. Link for values.	string	facetable exact
training_language.code	Code of language training is held in	string	facetable exact
type	Shortcut for type - defaults to type.name	string	searchable facetable exact multi common
type.id	Id for training type used by ReliefWeb	integer	searchable facetable	TY
type.name	Link for values	string	searchable facetable exact
url	Canonical url	string
url_alias	Friendly' url of the training	string	searchable

Name	Description	Type	Attributes	Abbreviation
content_type	Content types published from this source	array	sortable searchable
country	Shortcut for country - defaults to country.name	string	searchable facetable exact multi common
country.id	Id for country used by ReliefWeb	integer	searchable facetable	C
country.iso3	ISO 3166-1 alpha-3 code	string	searchable facetable exact
country.name	Name of the country in English where the source headquarters is located	string	searchable facetable exact
country.primary	Flag to indicate this is the primary country	boolean
country.shortname	Short name of the country in English where the source headquarters is located	string	searchable facetable exact
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
description	Description of the source in Markdown format	string	searchable
description-html	Description of the source in HTML format	string
disclaimer	Disclaimer information	string	searchable
fts_id	Id number for organization used by FTS	number	sortable searchable
homepage	URL of organization	string	searchable
id	Unique id for source used by ReliefWeb	integer	sortable searchable
logo	Shortcut for logo - defaults to logo.url	object
logo.filename	File name of the logo	string
logo.filesize	File size of the logo	string
logo.height	Height of the logo	integer
logo.id	Id for logo used by ReliefWeb	integer
logo.mimetype	MIME type of the logo	string
logo.url	URL of the logo	string
logo.width	Width of the logo	integer
longname	Official name of source, where applicable	string	sortable searchable exact
name	Name of source	string	sortable searchable exact
shortname	Name of the source in abbreviated format, where applicable	string	sortable searchable exact
spanish_name	Name of the source in Spanish	string	sortable searchable exact
status	Whether source is active or not	string	searchable facetable
type	Shortcut for type of organization - defaults to type.name	string	searchable facetable exact multi common
type.id	Id of organization type used by ReliefWeb	integer	searchable facetable	TY
type.name	Link for values	string	searchable facetable exact
url	Canonical url	string
url_alias	Friendly' url of the source	string	searchable

Name	Description	Type	Attributes	Abbreviation
body	Text in Markdown format	string searchable
body-html	Text in HTML format	string
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
id	Unique id of page used by ReliefWeb	number	sortable searchable
status	Published or not	string	facetable
title	Title of page	string	sortable exact
url	Canonical url of the page	string
url_alias	Friendly' url of page	string

Name	Description	Type	Attributes	Abbreviation
attached_image	Attached image shortcut - defaults to attached_image.id	integer
attached_image.caption	Caption attached to the image	string	searchable
attached_image.copyright	Copyright attached to the image	string	searchable
attached_image.id	Unique id of image used by ReliefWeb	integer	searchable
attached_image.mimetype	MIME type of the image	string
attached_image.filename	File name of the image	string
attached_image.url	Link to the original image	string
attached_image.url-large	Link to a large image with a width of 680px	string
attached_image.url-small	Link to a small image with a width of 200px	string
attached_image.url-thumb	Link to a thumbnail image with a maximum width of 220px and a maximum height of 100px	string
author	Name of blog post author	string	searchable exact
body	Text of blog post in Markdown format	string	searchable
body-html	Text of blog post in HTML format	string
date	Shortcut for date - defaults to date.created	object
date.changed	Date entry modified on ReliefWeb (ISO 8601)	date	sortable facetable
date.created	Date entry created on ReliefWeb (ISO 8601)	date	sortable facetable	DA
id	Id for blog post used by ReliefWeb	number	sortable searchable
image	Image shortcut - defaults to image.id	integer
image.caption	Caption attached to the image	string	searchable
image.copyright	Copyright attached to the image	string	searchable
image.id	Unique id of image used by ReliefWeb	integer	searchable
image.mimetype	MIME type of the image	string
image.filename	File name of the image	string
image.url	Link to the original image	string
image.url-large	Link to a large image with a width of 680px	string
image.url-small	Link to a small image with a width of 200px	string
image.url-thumb	Link to a thumbnail image with a maximum width of 220px and a maximum height of 100px	string
status	Published or not	string	facetable
tags	Shortcut for categories applied to blog post - defaults to tags.name	string	searchable facetable exact
tags.id	Unique id for blog post categories used by ReliefWeb	number	facetable
tags.name	Name of blog post categories	string	searchable facetable exact
title	Title of blog post	string	sortable exact
url	Canonical url of blog post	string
url_alias	Friendly' url of blog post	string

OCHA Services

ReliefWeb API Documentation

ReliefWeb API Fields tables

Introduction

The tables