References

Taxonomy vocabularies used for tagging (themes, disaster types, job types, languages, and more). For plain-language descriptions of terms, see Humanitarian Terms.

Look up a term to get its integer id, then use that id in filters or Publish payloads (reports, jobs, training). For example, searching /v2/references/languages for french returns id 268 (fields.name: French). You can then filter reports with {"field": "language.id", "value": 268}, or publish with "language": [268].

Endpoints

  • Index: GET https://api.reliefweb.int/v2/references: lists all vocabulary endpoints
  • Vocabulary: GET or POST https://api.reliefweb.int/v2/references/{vocabulary}: list or search terms in a vocabulary

The index response is the authoritative list of available vocabularies. Common ones are summarized below.

Search a vocabulary with query, for example:

GET https://api.reliefweb.int/v2/references/languages?appname=REPLACE-WITH-APP-NAME&query[value]=french

Example response (abbreviated):

{
  "totalCount": 1,
  "count": 1,
  "data": [
    {
      "id": 268,
      "fields": {
        "name": "French",
        "code": "fr"
      }
    }
  ]
}

Common vocabularies

Vocabulary Path
Career categories /v2/references/career-categories
Content formats /v2/references/content-formats
Disaster types /v2/references/disaster-types
Features /v2/references/features
Job experience /v2/references/job-experience
Job types /v2/references/job-types
Languages /v2/references/languages
OCHA products /v2/references/ocha-products
Organization types /v2/references/organization-types
Themes /v2/references/themes
Training formats /v2/references/training-formats
Training types /v2/references/training-types
Vulnerable groups (deprecated; no Terms page) /v2/references/vulnerable-groups