Read / search

Query curated ReliefWeb content as JSON at https://api.reliefweb.int/v2. Every call needs a pre-approved appname on the URL.

First call

List the latest reports. This example sets "profile": "list", which returns a practical default set of fields for browsing:

POST

https://api.reliefweb.int/v2/reports?appname=REPLACE-WITH-APP-NAME

{
  "limit": 2,
  "profile": "list"
}

A successful response includes totalCount, count, and a data array of items. See Response, limits, and errors for the response shape and an abbreviated example.

You can also refine a query on the ReliefWeb site and use the search converter to turn a listing URL into an API payload.

Request parameters

Parameter	Role	Notes
query	Full-text search	Object with value, optional fields and operator
filter	Hard constraints (country, date, theme, …)	Nested conditions with AND / OR
profile	Default fields in each result	/v2/{resource} defaults to minimal; /v2/{resource}/{id} to default
fields	Include or exclude specific fields	Refines the profile
preset	Bundled status filters and sort	Use analysis for archived or expired items
sort	Ordering	Relevance when query is set
limit	Page size	0–1000, default 10
offset	Page position	Default 0
facets	Category or date breakdowns	Often used with limit: 0
slim	Omit hypermedia links	Set to 1
verbose	Echo how the request was interpreted	Set to 1

For nested query, filter, or facets, prefer a JSON POST.