jolvAPI
jolv.app Open Jolv
API reference / Documents, news & ESG

ESG question set

Lists the ESG question set (section, category, indicator, label, response type, options). With campaign_id, only the questions configured for the campaign, with their mandatory flag. Join key (question_id) with get_esg. Read-only.

GET/v1/list_esg_referentiel

Query parameters

  • campaign_iduuidoptional
    Campaign UUID (optional): questions configured for that campaign, with the mandatory flag.
  • sectionstringoptional
    Filter by section (optional; e.g. Environment, Social, Governance).

Response

Status 200, application/json. Resources outside your rights are absent, never an error.

  • questionsobject[]
    Show child attributes
    • question_idstring
      Question UUID (esg_referentiel.id), join key with get_esg.
    • sectionstring · nullable
    • categorystring · nullable
    • sub_categorystring · nullable
    • indicatorstring · nullable
    • questionstring
    • response_typestring
      Expected response type (number, text, boolean, select…).
    • response_optionsstring[]
      Offered options (choice lists), empty otherwise.
    • filled_bystring · nullable
      Who fills in the question (portfolio company, team…).
    • requiredboolean · nullable
      Mandatory for the campaign (null without campaign_id).
    • sort_ordernumber

Errors

400 invalid parameter · 401 missing or expired token · 429 too many requests · 500 read failed. See Errors.