ScoutsList reports (inbox)

List reports (inbox)

The inbox, newest first. One report per finding. List rows carry a one-line headline instead of the full summary, evidence and history. A report built from a surface the caller's key cannot read (or from server logs on a HIPAA location) keeps its place in the list with an empty summary_md and a restricted object instead of its text.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/reports?location_id=example_string&scout_id=123e4567-e89b-12d3-a456-426614174000&status=open%2Csnoozed&priority=P0%2CP1&limit=50&cursor=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "location_id": "example_string",
      "scout_id": "123e4567-e89b-12d3-a456-426614174000",
      "scout_name": "John Doe",
      "skill": "example_string",
      "run_id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "example_string",
      "priority": "P0",
      "actionability": "immediately_actionable",
      "status": "open",
      "dedupe_key": "exceptions:4f2a9c",
      "families": [
        "example_string"
      ],
      "snoozed_until": "2024-12-25T10:00:00Z",
      "dismiss_reason": "example_string",
      "created_at": "2024-12-25T10:00:00Z",
      "updated_at": "2024-12-25T10:00:00Z",
      "status_changed_at": "2024-12-25T10:00:00Z",
      "edit_count": 10,
      "headline": "example_string",
      "summary_md": "example_string",
      "restricted": {
        "reason": "insufficient_scope",
        "required": "example_string"
      }
    }
  ],
  "next_cursor": "example_string"
}
GET
/client/v1/scouts/reports
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.
query
location_idstring

Only this client.

query
statusstring

Comma list of open, snoozed, resolved, dismissed, suppressed, or all. Default open,snoozed.

query
prioritystring

Comma list of P0, P1, P2, P3, P4.

query
limitinteger
Min: 1 • Max: 200
query
cursorstring

The next_cursor of the previous page.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Query Parameters

location_idstring

Only this client.

statusstring

Comma list of open, snoozed, resolved, dismissed, suppressed, or all. Default open,snoozed.

prioritystring

Comma list of P0, P1, P2, P3, P4.

Example:
P0,P1
cursorstring

The next_cursor of the previous page.

Responses

successboolean
datastring[]
next_cursorstring