jolvAPI
jolv.app Open Jolv
API reference / Campaigns

Campaign detail

Returns a valuation campaign's detail: the campaign (fund, date, status, collection deadline), its valuation sheets with their workflow status and milestones (submission, validation, sign-off, finalisation, sealing), counts by status and the campaign's status transitions (by role, never by name). No amounts: published values are served by get_valuation_fiche and list_portfolio. Read-only.

GET/v1/get_campaign

Query parameters

  • campaign_iduuidoptional
    Campaign UUID (optional when fund_id is given).
  • fund_iduuidoptional
    Fund UUID: without campaign_id, the fund's most recent campaign (valuation date, then creation).

Response

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

  • campaignobject
    Show child attributes
    • idstring
    • namestring · nullable
    • fund_idstring · nullable
    • fundstring · nullable
    • valuation_datestring · nullable
    • statusstring · nullable
      Campaign status (draft, changes_requested, finalized…).
    • collect_deadlinestring · nullable
      Deadline for collecting data from portfolio companies.
    • completed_atstring · nullable
    • last_transition_motifstring · nullable
    • cloned_from_campaign_idstring · nullable
    • created_atstring · nullable
  • countsobject
    Show child attributes
    • fichesnumber
    • draftnumber
    • pending_reviewnumber
    • validatednumber
    • approvednumber
    • rejectednumber
    • sealednumber
      Sealed sheets (frozen official document).
    • sanity_blockingnumber
      Sheets whose sanity check blocks submission.
  • fichesobject[]
    Show child attributes
    • valuation_idstring
      Sheet UUID (campaign_valuations.id), to pass to get_audit_thread.
    • company_idstring
    • companystring · nullable
    • fund_idstring · nullable
    • valuation_statusstring · nullable
      draft | pending_review | validated | approved | rejected
    • methodstring · nullable
    • is_exitedboolean
      Exit recorded on the sheet (sortie_at set).
    • sanity_blockingboolean
    • submitted_atstring · nullable
    • validated_atstring · nullable
    • approved_atstring · nullable
    • finalized_atstring · nullable
    • sealed_atstring · nullable
    • updated_atstring · nullable
  • transitionsobject[]
    Show child attributes
    • atstring
    • from_statusstring · nullable
    • to_statusstring
    • actor_rolestring · nullable
    • motifstring · nullable

Errors

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