v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

Investigations

Get list of Investigation types

Retrieves a filterable paginated list of investigation types

get/investigations/types

Query parameters

archivedboolean

E.g. true

pageNumnumber

Which page number to return. Default is 1

numRowsPerPagenumber

Limits results per page. Up to 100.

sortColumn'name' | 'use_case' | 'journeys_count'

sortOrder'DESC' | 'ASC'

onlyPermittedTypesboolean

Example:true

includeJourneysboolean

Example:true

Response

Success

Example response

{
  "investigation_types": [
    {
      "investigationTypeId": 1,
      "name": "Alert Review",
      "description": "JAs alerted",
      "archivedAt": "2024-12-05T20:05:43.643Z",
      "isBeingUsed": true,
      "useCase": "Fraud"
    }
  ]
}