Skip to main content
GET
List findings aggregated by component (purl@version)

Authorizations

Authorization
string
header
required

An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.

Query Parameters

project_id
string<uuid>
required

Project to aggregate findings for.

domain_slug
string

Filter to a specific domain slug.

q
string

Free-text search across component name and purl.

facet
string[]

Keep the components with at least one finding matching the selection. A kept component's counts (decided_count, total_count, state) still cover ALL of its findings: the selection decides which components appear, never how much of one is reviewed. The same <path>:<value> vocabulary and validation as GET /v1/findings' facet: values of one path are OR-ed, paths are AND-ed, and an unrecognised or non-entitled path is rejected with 400.

state
enum<string>

Filter by component state (open, resolved, partial).

Available options:
open,
resolved,
partial
scan_id
string<uuid>

Aggregate the components as this scan saw them. For any other scan the parameter changes nothing: the list stays the project-wide one.

sort
enum<string>
default:open_first

Sort order. Default is open-first (open components before resolved).

Available options:
open_first,
name_asc
limit
integer
default:20

Maximum number of components to return. 0 returns the complete component set in a single response (no pagination). Values above 100 fall back to the default of 20, preserving prior behavior.

Required range: 0 <= x <= 100
offset
integer
default:0

Response

Paginated list of components

items
object[]
required
total
integer
required

Total number of components matching the query (before pagination).

limit
integer
required
offset
integer
required