Skip to content
Invogi Docs

List findings for a scan

GET
/scans/{scanId}/findings
curl --request GET \
  --url 'https://api.invogi.com/v1/scans/example/findings?limit=50&offset=0&severity=INFO&disposition=OPEN' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
scanId
required
string

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 50 >= 1 <= 200
offset
integer
0
severity
string
Allowed values: INFO LOW MEDIUM HIGH CRITICAL
type
string
disposition
string
Allowed values: OPEN CONFIRMED FALSE_POSITIVE ACCEPTED_RISK
q
string
>= 1 characters <= 100 characters

Case-insensitive match on the finding summary

Responses

Section titled “Responses”

200

Section titled “200”

Finding page

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
invoiceId

Null for payment-only findings

string | null format: uuid
invoiceNumber
string | null
supplierId
string | null format: uuid
supplierName
string | null
scanId

Source historical scan; null for real-time invoices

string | null format: uuid
type
required
string
severity
required
string
Allowed values: INFO LOW MEDIUM HIGH CRITICAL
summary
required
string
recommendedAction
string | null
confidence
number
<= 1
evidence
object
key
additional properties
any
relatedInvoiceIds
Array<string>
disposition
string
Allowed values: OPEN CONFIRMED FALSE_POSITIVE ACCEPTED_RISK
total
required

Findings matching the filters

integer
limit
required
integer
offset
required
integer
dispositionCounts

Whole-scan finding counts by disposition, ignoring filters and paging

object
key
additional properties
integer

Example 

{
  "items": [
    {
      "severity": "INFO",
      "disposition": "OPEN"
    }
  ]
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Section titled “404”

Resource not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}