Skip to main content
List compliance check findings

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as confidence.level. id is always returned. Fields: id, alert_id, title, explanation, correction_type, currency, impact_amount, confidence, questions, invoice_line, invoiced, expected, price_items, citations, position.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
citation_context
enum<string>

true adds context_before and context_after to document citations: the text around each quote, used to locate it in the document.

Available options:
true,
false

Response

A bounded page of findings.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required