ReliefWeb (Independent Publisher) (Preview)

  • Reference

ReliefWeb is a humanitarian information service provided by the United Nations Office for the Coordination of Humanitarian Affairs (OCHA). Our editors select, classify, curate and deliver the content that is most relevant to global humanitarian workers and decision-makers on a 24/7 basis, enabling them to make informed decisions and to plan effective response.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://reliefweb.int/
Privacy policy https://reliefweb.int/
Categories Data

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get a country

Retrieve an individual country.
Get a disaster

Retrieve an individual disaster.
Get a job

Retrieve an individual job.
Get a report

Retrieve an individual report.
Get a source

Retrieve an individual source.
Get a training

Retrieve an individual training opportunity.
List or search countries

Retrieves a list of countries.
List or search disasters

Retrieve a list of disasters.
List or search humanitarian job offers

Retrieve a list of job offers.
List or search organizations providing content to ReliefWeb

Retrieve a list of organizations.
List or search trainings

Retrieve a list of humanitarian learning opportunities. Training opportunities and courses for useful and necessary humanitarian skills.
List or search updates, headlines or maps

Retrieve a list of reports. Reports are updates and analysis curated from more than 4,000 sources and tagged by our team of editors working around the clock.

Get a country

Operation ID:
GetCountryById

Retrieve an individual country.

Parameters

Name Key Required Type Description
ID
 countryId True string

The identifier of the country
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
Created
 data.fields.date.created string

The created.
URL Alias
 data.fields.url_alias string

The URL address alias.
Name
 data.fields.name string

The name.
Longitude
 data.fields.location.lon float

The longitude.
Latitude
 data.fields.location.lat float

The latitude.
ID
 data.fields.id integer

The identifier.
Short Name
 data.fields.shortname string

The short name.
URL
 data.fields.url string

The URL address.
Status
 data.fields.status string

The status.
ISO3
 data.fields.iso3 string

The country code.

Get a disaster

Operation ID:
GetDisasterById

Retrieve an individual disaster.

Parameters

Name Key Required Type Description
ID
 disasterId True string

The identifier of the disaster
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
Event
 data.fields.date.event string

The event.
Created
 data.fields.date.created string

The created.
Code
 data.fields.primary_type.code string

The code.
Name
 data.fields.primary_type.name string

The name.
ID
 data.fields.primary_type.id integer

The identifier.
Country
 data.fields.country array of object
HREF
 data.fields.country.href string

The HREF.
Name
 data.fields.country.name string

The name.
Longitude
 data.fields.country.location.lon float

The longitude.
Latitude
 data.fields.country.location.lat float

The latitude.
ID
 data.fields.country.id integer

The identifier.
Short Name
 data.fields.country.shortname string

The short name.
ISO3
 data.fields.country.iso3 string

The country code.
Primary
 data.fields.country.primary boolean

Whether primary.
HREF
 data.fields.primary_country.href string

The HREF.
Name
 data.fields.primary_country.name string

The name.
Longitude
 data.fields.primary_country.location.lon float

The longitude.
Latitude
 data.fields.primary_country.location.lat float

The latitude.
ID
 data.fields.primary_country.id integer

The identifier.
Short Name
 data.fields.primary_country.shortname string

The short name.
ISO3
 data.fields.primary_country.iso3 string

The country code.
Overview
 data.fields.profile.overview string

The overview.
Overview HTML
 data.fields.profile.overview-html string

The overview HTML.
Description HTML
 data.fields.description-html string

The description HTML.
Description
 data.fields.description string

The description.
Type
 data.fields.type array of object
Code
 data.fields.type.code string

The code.
Name
 data.fields.type.name string

The name.
ID
 data.fields.type.id integer

The identifier.
Primary
 data.fields.type.primary boolean

Whether primary.
URL
 data.fields.url string

The URL address.
URL Alias
 data.fields.url_alias string

The URL address alias.
Name
 data.fields.name string

The name.
ID
 data.fields.id integer

The identifier.
Glide
 data.fields.glide string

The glide.
Status
 data.fields.status string

The status.

Get a job

Operation ID:
GetJobById

Retrieve an individual job.

Parameters

Name Key Required Type Description
ID
 jobId True string

The identifier of the job.
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
Created
 data.fields.date.created string

The created.
Closing
 data.fields.date.closing string

The closing.
Country
 data.fields.country array of object
HREF
 data.fields.country.href string

The HREF.
Name
 data.fields.country.name string

The name.
Longitude
 data.fields.country.location.lon float

The longitude.
Latitude
 data.fields.country.location.lat float

The latitude.
ID
 data.fields.country.id integer

The identifier.
Short Name
 data.fields.country.shortname string

The short name.
ISO3
 data.fields.country.iso3 string

The country code.
career_categories
 data.fields.career_categories array of object
Name
 data.fields.career_categories.name string

The name.
ID
 data.fields.career_categories.id integer

The identifier.
Source
 data.fields.source array of object
HREF
 data.fields.source.href string

The HREF.
Long Name
 data.fields.source.longname string

The long name.
Name
 data.fields.source.name string

The name.
ID
 data.fields.source.id integer

The identifier.
Name
 data.fields.source.type.name string

The name.
ID
 data.fields.source.type.id integer

The identifier.
Short Name
 data.fields.source.shortname string

The short name.
Homepage
 data.fields.source.homepage string

The homepage.
Title
 data.fields.title string

The title.
Body
 data.fields.body string

The body.
Type
 data.fields.type array of object
Name
 data.fields.type.name string

The name.
ID
 data.fields.type.id integer

The identifier.
Experience
 data.fields.experience array of object
Name
 data.fields.experience.name string

The name.
ID
 data.fields.experience.id integer

The identifier.
URL
 data.fields.url string

The URL address.
URL Alias
 data.fields.url_alias string

The URL address alias.
How To Apply
 data.fields.how_to_apply string

The how to apply.
Theme
 data.fields.theme array of object
Name
 data.fields.theme.name string

The name.
ID
 data.fields.theme.id integer

The identifier.
ID
 data.fields.id integer

The identifier.
Status
 data.fields.status string

The status.
Body HTML
 data.fields.body-html string

The body HTML.
How To Apply HTML
 data.fields.how_to_apply-html string

The how to apply HTML.

Get a report

Operation ID:
GetReportById

Retrieve an individual report.

Parameters

Name Key Required Type Description
ID
 reportId True string

The identifier of the report.
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
Created
 data.fields.date.created string

The created.
Original
 data.fields.date.original string

The original.
Country
 data.fields.country array of object
HREF
 data.fields.country.href string

The HREF.
Name
 data.fields.country.name string

The name.
Longitude
 data.fields.country.location.lon float

The longitude.
Latitude
 data.fields.country.location.lat float

The latitude.
ID
 data.fields.country.id integer

The identifier.
Short Name
 data.fields.country.shortname string

The short name.
ISO3
 data.fields.country.iso3 string

The country code.
Primary
 data.fields.country.primary boolean

Whether primary.
Origin
 data.fields.origin string

The origin.
HREF
 data.fields.primary_country.href string

The HREF.
Name
 data.fields.primary_country.name string

The name.
Longitude
 data.fields.primary_country.location.lon float

The longitude.
Latitude
 data.fields.primary_country.location.lat float

The latitude.
ID
 data.fields.primary_country.id integer

The identifier.
Short Name
 data.fields.primary_country.shortname string

The short name.
ISO3
 data.fields.primary_country.iso3 string

The country code.
Format
 data.fields.format array of object
Name
 data.fields.format.name string

The name.
ID
 data.fields.format.id integer

The identifier.
Language
 data.fields.language array of object
Code
 data.fields.language.code string

The code.
Name
 data.fields.language.name string

The name.
ID
 data.fields.language.id integer

The identifier.
Source
 data.fields.source array of object
HREF
 data.fields.source.href string

The HREF.
Long Name
 data.fields.source.longname string

The long name.
Spanish Name
 data.fields.source.spanish_name string

The Spanish name.
Name
 data.fields.source.name string

The name.
ID
 data.fields.source.id integer

The identifier.
Name
 data.fields.source.type.name string

The name.
ID
 data.fields.source.type.id integer

The identifier.
Short Name
 data.fields.source.shortname string

The short name.
Homepage
 data.fields.source.homepage string

The homepage.
Title
 data.fields.title string

The title.
Body
 data.fields.body string

The body.
URL
 data.fields.url string

The URL address.
File
 data.fields.file array of object
URL Thumbnail
 data.fields.file.preview.url-thumb string

The URL thumbnail.
URL Small
 data.fields.file.preview.url-small string

The URL small.
URL Large
 data.fields.file.preview.url-large string

The URL large.
Version
 data.fields.file.preview.version string

The version.
URL
 data.fields.file.preview.url string

The URL address.
Filename
 data.fields.file.filename string

The filename.
Description
 data.fields.file.title string

The description.
MIME Type
 data.fields.file.mimetype string

The MIME type.
ID
 data.fields.file.id string

The identifier.
File Size
 data.fields.file.filesize string

The file size.
URL
 data.fields.file.url string

The URL address.
URL Alias
 data.fields.url_alias string

The URL address alias.
Theme
 data.fields.theme array of object
Name
 data.fields.theme.name string

The name.
ID
 data.fields.theme.id integer

The identifier.
ID
 data.fields.id integer

The identifier.
Status
 data.fields.status string

The status.
Body HTML
 data.fields.body-html string

The body HTML.

Get a source

Operation ID:
GetSourceById

Retrieve an individual source.

Parameters

Name Key Required Type Description
ID
 sourceId True string

The identifier of the source
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
Created
 data.fields.date.created string

The created.
Long Name
 data.fields.longname string

The long name.
Country
 data.fields.country array of object
HREF
 data.fields.country.href string

The HREF.
Name
 data.fields.country.name string

The name.
Longitude
 data.fields.country.location.lon float

The longitude.
Latitude
 data.fields.country.location.lat float

The latitude.
ID
 data.fields.country.id integer

The identifier.
Short Name
 data.fields.country.shortname string

The short name.
ISO3
 data.fields.country.iso3 string

The country code.
Name
 data.fields.type.name string

The name.
ID
 data.fields.type.id integer

The identifier.
Short Name
 data.fields.shortname string

The short name.
URL
 data.fields.url string

The URL address.
URL Alias
 data.fields.url_alias string

The URL address alias.
content_type
 data.fields.content_type array of string
Name
 data.fields.name string

The name.
Filename
 data.fields.logo.filename string

The filename.
Width
 data.fields.logo.width string

The width.
MIME Type
 data.fields.logo.mimetype string

The MIME type.
ID
 data.fields.logo.id string

The identifier.
File Size
 data.fields.logo.filesize string

The file size.
URL
 data.fields.logo.url string

The URL address.
Height
 data.fields.logo.height string

The height.
ID
 data.fields.id integer

The identifier.
Status
 data.fields.status string

The status.
Homepage
 data.fields.homepage string

The homepage.

Get a training

Operation ID:
GetTrainingById

Retrieve an individual training opportunity.

Parameters

Name Key Required Type Description
ID
 trainingId True string

The identifier of the training opportunity.
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.collection.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Changed
 data.fields.date.changed string

The changed.
End
 data.fields.date.end string

The end.
Start
 data.fields.date.start string

The start.
Created
 data.fields.date.created string

The created.
Cost
 data.fields.cost string

The cost.
How To Register
 data.fields.how_to_register string

The how to register.
How To Register HTML
 data.fields.how_to_register-html string

The how to register HTML.
training_language
 data.fields.training_language array of object
Code
 data.fields.training_language.code string

The code.
Name
 data.fields.training_language.name string

The name.
ID
 data.fields.training_language.id integer

The identifier.
Format
 data.fields.format array of object
Name
 data.fields.format.name string

The name.
ID
 data.fields.format.id integer

The identifier.
Language
 data.fields.language array of object
Code
 data.fields.language.code string

The code.
Name
 data.fields.language.name string

The name.
ID
 data.fields.language.id integer

The identifier.
Source
 data.fields.source array of object
HREF
 data.fields.source.href string

The HREF.
Long Name
 data.fields.source.longname string

The long name.
Spanish Name
 data.fields.source.spanish_name string

The Spanish name.
Name
 data.fields.source.name string

The name.
ID
 data.fields.source.id integer

The identifier.
Name
 data.fields.source.type.name string

The name.
ID
 data.fields.source.type.id integer

The identifier.
Short Name
 data.fields.source.shortname string

The short name.
Homepage
 data.fields.source.homepage string

The homepage.
Title
 data.fields.title string

The title.
Body
 data.fields.body string

The body.
Type
 data.fields.type array of object
Name
 data.fields.type.name string

The name.
ID
 data.fields.type.id integer

The identifier.
Event URL
 data.fields.event_url string

The event URL address.
URL
 data.fields.url string

The URL address.
Fee Information
 data.fields.fee_information string

The fee information.
URL Alias
 data.fields.url_alias string

The URL address alias.
ID
 data.fields.id integer

The identifier.
Status
 data.fields.status string

The status.
Body HTML
 data.fields.body-html string

The body HTML.

List or search countries

Operation ID:
GetCountries

Retrieves a list of countries.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Name
 data.fields.name string

The name.
HREF
 data.href string

The HREF.

List or search disasters

Operation ID:
GetDisasters

Retrieve a list of disasters.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Name
 data.fields.name string

The name.
HREF
 data.href string

The HREF.

List or search humanitarian job offers

Operation ID:
GetJobs

Retrieve a list of job offers.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Title
 data.fields.title string

The title.
HREF
 data.href string

The HREF.

List or search organizations providing content to ReliefWeb

Operation ID:
GetSources

Retrieve a list of organizations.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Name
 data.fields.name string

The name.
HREF
 data.href string

The HREF.

List or search trainings

Operation ID:
GetTraining

Retrieve a list of humanitarian learning opportunities. Training opportunities and courses for useful and necessary humanitarian skills.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Title
 data.fields.title string

The title.
HREF
 data.href string

The HREF.

List or search updates, headlines or maps

Operation ID:
GetReports

Retrieve a list of reports. Reports are updates and analysis curated from more than 4,000 sources and tagged by our team of editors working around the clock.

Parameters

Name Key Required Type Description
Query Value
 query-value string

Specify the terms of your fuzzy search. The default is no query.
Query Operator
 query-operator string

Specify the operator by which your search query words will be combined.
Query Fields
 query-fields array

Specify which fields to target with your search. You may use boost syntax here, see the Advanced API Usage documentation.
Filter Field
 filter-field string

Field to filter by. Every condition must contain either a field or conditions property.
Filter Value
 filter-value array

Value for the field being filtered. Leave blank to require existence of the field, must be present for range and value conditions.
Filter Operator
 filter-operator string

Operator by which filters will be combined.
Filter Negate
 filter-negate boolean

Reverse the filter to include those items that do not match.
Filter Conditions
 filter-conditions array

This property is used to combine conditions with a logical connector (the operator property). Every condition must contain one of the field or conditions properties.
Facet Field
 facets-field string

Field to facet by. May include dates, references or the status field.
Facets Name
 facets-name string

Identifier for resulting facet data. Useful when faceting multiple ways on the same field.
Facets Limit
 facets-limit integer

Limit the number of facets returned for non-date based facets.
Facets Sort
 facets-sort string

The sort order of non-date facets. Sorting may be by value or count of terms, and ascending or descending. count defaults to desc, value defaults to asc.
Facets Filter
 facets-filter array

Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Facets Interval
 facets-interval string

Round date information to the nearest interval unit. Apply all the same capabilities of the filter parameter to the specific results of this facet request.
Include Fields
 fields-include array

Specify which fields to include for each item. Defaults to an item label.
Exclude Fields
 fields-exclude array

Specify sub-fields to exclude from overall results. For example, if you include date you may exclude date.changed.
Limit
 limit integer

The maximum number of items to return for a list query. The default is 10 and the maximum 1000.
Offset
 offset integer

The offset from which to return the items in a list query. Allows paging through all results. The default is 0.
Sort
 sort array

Sort the list results. Defaults to search relevance. Values in the form of field name:(asc|desc).
Profile
 profile string

Pre-built standard selections of fields to return for ease of displaying lists or items.
Preset
 preset string

Pre-built standard configurations of queries, filters and sorts for common use cases.

Returns

Name Path Type Description
Time
 time integer

The time.
HREF
 href string

The HREF.
HREF
 links.self.href string

The HREF.
HREF
 links.next.href string

The HREF.
HREF
 links.prev.href string

The HREF.
Took
 took integer

The took.
Total Count
 totalCount integer

The total count.
Count
 count integer

The count.
Data
 data array of object
ID
 data.id string

The identifier.
Score
 data.score integer

The score.
Title
 data.fields.title string

The title.
HREF
 data.href string

The HREF.