Sources
Organizations that publish content on ReliefWeb (reliefweb.int/organizations), exposed in the API as sources (id, name, shortname, longname, type, country, homepage, fts_id).
Query /v2/sources to resolve organization id or shortname values for filtering or publishing. There are more than 1,000 sources, so use limit and offset (Sort and paginate) if fetching the full set.
- Endpoint:
POSTorGET https://api.reliefweb.int/v2/sources - Single source:
GET https://api.reliefweb.int/v2/sources/{id|uuid}
Defaults
Requests to /v2/sources default to profile=minimal and preset=minimal. Single-record requests (/v2/sources/{id}) default to profile=default and preset=minimal. See Choose fields and presets.
Profiles
| Profile | Fields |
|---|---|
minimal |
name
|
list |
name, shortname, homepage, status, url
|
suggest |
name, shortname (sets slim)
|
full |
All fields |
default |
All fields |
Add more with fields.include.
Presets
| Preset | Status filter | Sort | Default query fields |
|---|---|---|---|
minimal |
active, inactive |
n/a | name |
latest |
active, inactive |
id:desc |
name, shortname, longname, spanish_name |
analysis |
active, inactive, archive |
n/a | name, shortname, longname, spanish_name, status |
Available fields
| Name | Description | Type | Attributes |
|---|---|---|---|
content_type |
Content types published from this source | array | searchable sortable |
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 |
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 | 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 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 | searchable sortable |
homepage |
URL of organization | string | searchable |
id |
Unique id for source used by ReliefWeb | integer | searchable sortable |
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 | searchable sortable exact |
longname.collation_en |
Long name field for English collation-aware sorting | string | sortable |
name |
Name of source organization | string | searchable sortable exact |
name.collation_en |
Name field for English collation-aware sorting | string | sortable |
redirects |
Previous URL aliases that redirect to this item | string | searchable |
shortname |
Name of the source in abbreviated format, where applicable | string | searchable sortable exact |
shortname.collation_en |
Short name field for English collation-aware sorting | string | sortable |
spanish_name |
Name of the source in Spanish | string | searchable sortable exact |
spanish_name.collation_es |
Spanish name field for Spanish collation-aware sorting | string | sortable |
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 |
type.name |
Link for values | string | searchable facetable exact |
url |
Canonical url | string | |
url_alias |
Friendly' url of the source | string | searchable |
uuid |
UUID of the document or term | string | searchable |