---
title: "List external knowledge panel sources (JSON)"
method: GET
path: "/api/v3/external_sources"
tags: ["Knowledge Panels"]
---

# List external knowledge panel sources (JSON)

`GET /api/v3/external_sources`

## Request

- Base URL: `https://world.openfoodfacts.org`
- URL: `https://world.openfoodfacts.org/api/v3/external_sources`
- Auth: API key in header `User-Agent`

Returns the ordered list of external knowledge panel sources configured on the server.

Providers can use the `knowledge_panel_url` field to point to their own API.
The URL may contain **template variables** that the frontend will expand before calling:

- `$code` → product barcode
- `$lc`   → UI language (2 letters)
- `$cc`   → user/device country (2 letters)

Example:
`https://provider.example.com/off/v1/knowledge-panel/$code?lang=$lc&country=$cc`

The frontend percent-encodes the variable values when substituting them into the URL.

## Response `200`

OK

- object: A response object to describe if a READ or WRITE request was successful or not, and if there were errors or warnings, and what the impact of those errors or warnings was.
  - `status` 'success' | 'success_with_warnings' | 'success_with_errors' | 'failure': Overall status of the request: whether it failed or succeeded, with or without warnings or errors.
  - `result` object: Overall result of the request (e.g. a product has been created)
    - `id` string: Identifier of a response result entry
    - `name` string: Name of the response result entry in English.
    - `lc_name` string: Name of the response result entry in the language specified in tags_lc, if supplied.
  - `warnings` WarningOrError[]: List of warnings. Warnings are used to alert about something that may be wrong, but is not necessarily wrong (e.g. a nutrient value that is unexpectedly high).
    - `message` object
      - `id` string: Identifier of a response message.
      - `name` string: Name of the response message entry in English.
      - `lc_name` string: Name of the response message entry in the language specified in tags_lc, if supplied.
      - `description` string: Description of the problem specific to the request, in English.
      - `lc_description` string: Description of the problem specific to the request, in the language specified in tags_lc, if supplied.
    - `field` object: Field that triggered the warning or error.
      - `id` string: Name of the field that triggered the warning or error.
      - `value` string: Value of the field that triggered the warning or error.
    - `impact` object
      - `id` string
      - `name` string
      - `lc_name` string
      - `description` string
      - `lc_description` string
  - `errors` WarningOrError[]: List of errors. Errors are used to alert about something that is definitely wrong (e.g. a nutrient value that is impossibly high).
    - `message` object
      - `id` string: Identifier of a response message.
      - `name` string: Name of the response message entry in English.
      - `lc_name` string: Name of the response message entry in the language specified in tags_lc, if supplied.
      - `description` string: Description of the problem specific to the request, in English.
      - `lc_description` string: Description of the problem specific to the request, in the language specified in tags_lc, if supplied.
    - `field` object: Field that triggered the warning or error.
      - `id` string: Name of the field that triggered the warning or error.
      - `value` string: Value of the field that triggered the warning or error.
    - `impact` object
      - `id` string
      - `name` string
      - `lc_name` string
      - `description` string
      - `lc_description` string
  - `external_sources` ExternalKnowledgePanel[]: Ordered list of external knowledge panel sources.
    - `id` string, required: Unique identifier of the external panel within the file.
    - `name` string, required: End-user display name of the panel or provider.
    - `description` string: Short description shown in preferences and provider header.
    - `icon_url` string, uri: URL to a square logo (PNG/SVG).
    - `knowledge_panel_url` string, uri, required: Base URL to fetch knowledge panels **from the external provider**. The URL can contain the following **template variables**, replaced by the frontend: - `$code` → product barcode - `$lc` → UI language (2 letters) - `$cc` → user/device country (2 letters) Example: `https://provider.example.com/off/v1/knowledge-panel/$code?lang=$lc&country=$cc` Notes: - The frontend substitutes variables with percent-encoded values. - The web component does not auto-append language anymore: include `?lang=$lc` yourself if needed.
    - `provider_name` string: Provider organization display name.
    - `provider_website` string, uri: Public website of the provider (linked in UI).
    - `privacy_policy_url` string, uri: Link to privacy notice for the external service (optional).
    - `section` string, required: Machine id of the section this panel belongs to (e.g. `animal_welfare`).
    - `scope` 'public' | 'users' | 'moderators': Visibility scope of the panel.
    - `user_in_scope` boolean: True if current user is in the panel scope. You must make an authenticated request to have this set to the right values (otherwise it will be the value corresponding to public scope)
    - `filters` object: Display filters applied on the current product context.
      - `categories` string[]: List of category tags; panel is shown if any matches the product categories.
      - `countries` string[]: Two-letter country codes (or "world"); strict equality with current user/device country.
      - `languages` string[]: Two-letter language codes; strict equality with current UI language.
      - `product_types` string[]: Product types (e.g. "food"); strict equality with current product type.

## Changes

- **2026-11-18** (v3) `ab04ff78cb83`: 1 breaking, 14 info
  - the `allOf[subschema #2]/external_sources/items/` response's property type changed from no type to `object` for status `200`
  - added `#/components/schemas/response_status` to the response body `allOf` list for the response status `200`
  - removed `#/components/schemas/response_status.yaml` from the response body `allOf` list for the response status `200`
  - added the optional property `allOf[subschema #2]/external_sources/items/description` to the response with the `200` status
  - …11 more
- **2025-10-30** (v3) `9c1d3f01f0e3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openfoodfacts/apis/open-food-facts-open-api-v3-under-development/changes/api/v3/external_sources/get.md)

---

[API](https://skmtc.dev/openfoodfacts/apis/open-food-facts-open-api-v3-under-development.md) - [All operations](https://skmtc.dev/openfoodfacts/apis/open-food-facts-open-api-v3-under-development/llms.txt) - [OpenAPI document](https://skmtc.dev/openfoodfacts/apis/open-food-facts-open-api-v3-under-development/revisions/ab04ff78cb83?raw)
