ESG

ESG Case

Get properties of an ESG case by its id

GET
https://api.textreveal.com/v3/esg/cases/{case_id}

Request

Parameters

  • case_id*uuid

    Unique identifier of the case

  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "categories", "entity_id", "dashboard_url", "last_activity", "score", "start_date", "sub_categories", "summary", "title", "related_events_count", "related_documents_count"]Values: "id", "categories", "entity_id", "dashboard_url", "last_activity", "score", "start_date", "sub_categories", "summary", "title", "related_events_count", "related_documents_count"

Response

Response - 200

Properties of the case

  • iduuid

    Unique identifier of the case.

    Example: "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"
  • categories(string (enum))[]

    List of categories assigned to the case.

    Values: "E", "S", "G"
  • entity_iduuid

    Permanent ID of the related entity.

  • dashboard_urluri | null

    Link to the case in SESAMm's Dashboard.

    Example: "https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9"
  • last_activitydate-time

    Last activity detected on the case. Corresponds to the date of the newest document associated to the case.

  • scoreinteger

    Intensity score.

    Range: [1, 5]
  • start_datedate-time

    Case start date. Corresponds to the date of the oldest document associated to the case.

  • sub_categoriesstring[]

    List of sub-categories assigned to the case.

  • summarystring | null

    Summary of the case.

  • titlestring

    Title of the case.

Response
{
  "id": "5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "categories": [
    "E"
  ],
  "entity_id": "00000000-0000-0000-0000-000000000000",
  "dashboard_url": "https://dashboards.textreveal.com/case/5eb7182b-9b55-4f7a-b3e1-49062ee7cef9",
  "last_activity": "2025-04-09T14:15:54.000Z",
  "score": 2,
  "start_date": "2025-04-09T14:15:54.000Z",
  "sub_categories": [
    "string"
  ],
  "summary": "string",
  "title": "string",
  "related_events_count": 8,
  "related_documents_count": 43
}