Fetch all alerts
List all alerts from previously checked activities.
Headers
apiKey
X-Frankie-CustomerID
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildID
Your Customer Child ID provided by FrankieOne
Query parameters
entityId
Unique identifier of a FrankieOne entity
isActive
A boolean value to whether we want to only fetch the alerts that have not been resolved
types
comma delimited list of EnumRiskResultType
Allowed values:
subtypes
comma delimited list of strings representing the Subtypes
riskLevels
comma delimited list of strings representing the risk levels
Allowed values:
assignedTo
User identifier that will filter based on which alerts are assigned to
activityType
comma delimited list of EnumActivityType
offset
Number of items to offset by
limit
Limit to the Number of Results to return in the response payload
order
The order in which the records will be sorted in before returning in the response payload
Allowed values:
sortField
Field that the alerts will be sorted upon
Allowed values:
Response
Response from the GET /alerts endpoint
data
List of Transaction Check Alerts found from the query
meta