a13nDocs
API referenceFindings

List Findings

GET/api/v1/findings

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Query Parameters

agent_id?string|null
category?|null
severity?|null
assessment?|null
closed?boolean|null
limit?Limit
Range1 <= value <= 100
Default50
cursor?string|null

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/findings"
{  "items": [    {      "agent_id": "string",      "agent_revision_id": "string",      "analysis_id": "string",      "assessment": "unreviewed",      "assessment_note": "string",      "category": "unclear_request",      "closed": true,      "created_at": "2019-08-24T14:15:22Z",      "created_by_id": "string",      "evidence": [        {          "run_id": "string",          "span_ids": [            "string"          ],          "trace_id": "string"        }      ],      "explanation": "string",      "id": "string",      "limitations": "",      "severity": "critical",      "source_key": "string",      "source_run_id": "string",      "suggestion": "string",      "title": "string",      "updated_at": "2019-08-24T14:15:22Z",      "version": 0,      "workspace_id": "string"    }  ],  "next_cursor": "string"}