v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

Investigations

Get list of Investigations

Retrieves a filterable paginated list of investigations

get/investigations

Query parameters

statusesstring

Listed by Get Investigation filters. E.g. ["alert_review"].

typesstring

Listed by Get Investigation filters. E.g. ["Fraud"].

assignedAgentsstring

Listed by Get Investigation filters. E.g. ["AG-L83m6iTwcXdNg3CHndS4"]

entityTokensstring

E.g. ["P-KaKZxdSGnbxXfKXnXdyp"]

investigationTokensstring

E.g. ["INV-EAx2xoAsqF1ibKTQzkXV"]

externalEntityIdsstring

E.g. ["external_entity_id"]

deviceIdsstring

E.g. ["device_vendor_identifier"]

programNamesstring

E.g. ["program_name"]

includeClosedboolean

archivedboolean

E.g. false

createdAtFromnumber

E.g. 1737742979

createdAtTonumber

E.g. 1737742979

updatedAtFromnumber

E.g. 1737742979

updatedAtTonumber

E.g. 1737742979

pageNumnumber

Which page number to return. Default is 1

numRowsPerPagenumber

Limits results per page. Up to 100.

sortColumn'updated_at' | 'created_at' | 'total_alerts' | 'risk_score'

sortOrder'DESC' | 'ASC'

Response

Success

errorobject

Example response

{
  "_embedded": {
    "pagination": {
      "total_investigations": 95,
      "total_pages": 4,
      "page": 1,
      "per_page": 20
    },
    "sorting": {
      "column": "update_at",
      "order": "DESC"
    }
  },
  "investigations": [
    {
      "investigation_token": "INV-EAx2xoAsqF1ibKTQzkXV",
      "name": "Nick Armstrong's investigation",
      "total_alerts": 2,
      "type": "Fraud",
      "state": "alert_review",
      "source": "alert",
      "outcome": "Dismissed",
      "created_at": "2024-11-26T16:00:14.677Z",
      "updated_at": "2024-11-26T16:00:14.677Z",
      "_embedded": {
        "entities": {
          "P-KaKZxdSGnbxXfKXnXdyp": {
            "entity_name": "Nick Armstrong",
            "entity_type": "person",
            "entity_token": "P-KaKZxdSGnbxXfKXnXdyp",
            "risk_score": 0.7
          }
        },
        "assigned_agent": {
          "first_name": "Mike",
          "last_name": "Alloy",
          "email": "agent@email.com",
          "token": "AG-L83m6iTwcXdNg3CHndS4"
        }
      },
      "device_ids": [
        "device_vendor_identifier"
      ],
      "program_names": [
        "Program name"
      ],
      "alert_assignees": [
        "Agent name"
      ]
    }
  ]
}