Skip to main content
GET
/
v2
/
findings
Get findings
curl --request GET \
  --url https://api.ghostsecurity.ai/v2/findings \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "items": [
    {
      "agent": {
        "description": "<string>",
        "name": "<string>",
        "vector": "<string>"
      },
      "created_at": "<string>",
      "details": {
        "code": "<string>",
        "description": "<string>",
        "endpoint": {
          "authn": {
            "implemented": true
          },
          "authz": {
            "implemented": true
          },
          "created_at": "<string>",
          "findings_count": 123,
          "id": "<string>",
          "location": {
            "class_name": "<string>",
            "file_path": "<string>",
            "line_number": 123,
            "method_name": "<string>",
            "url": "<string>"
          },
          "method": "<string>",
          "path_template": "<string>",
          "updated_at": "<string>"
        },
        "exploit_feasibility": "<string>",
        "exploit_walkthrough": "<string>",
        "fixed_code": "<string>",
        "location": {
          "class_name": "<string>",
          "file_path": "<string>",
          "line_number": 123,
          "method_name": "<string>",
          "url": "<string>"
        },
        "remediation": "<string>",
        "remediation_effort": "<string>",
        "severity": "<string>",
        "supporting_files": [
          {
            "class_name": "<string>",
            "file_path": "<string>",
            "line_number": 123,
            "method_name": "<string>",
            "url": "<string>"
          }
        ],
        "title": "<string>",
        "validation_evidence": [
          {
            "criteria": "<string>",
            "rationale": "<string>"
          }
        ]
      },
      "id": "<string>",
      "organization_id": "<string>",
      "project": {
        "id": "<string>",
        "name": "<string>"
      },
      "repo": {
        "id": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "scan_details": {
        "analyzed_at": "<string>",
        "rejected_at": "<string>",
        "scan_id": "<string>",
        "verified_at": "<string>"
      },
      "status": "<string>",
      "updated_at": "<string>",
      "user_status": "<string>"
    }
  ],
  "next_cursor": "eyJzb3J0X3ZhbHVlIjoiMjAyNC0wMS0xNVQxMDozMDowMFoiLCJkb2N1bWVudF9pZCI6InJlcG8xMjMiLCJzb3J0X2ZpZWxkIjoiY3JlYXRlZF9hdCJ9",
  "total": 250
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string

Pagination cursor

​
sort
enum<string>
default:created_at

Sort field

Available options:
created_at,
updated_at
​
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
​
size
integer
default:100

Page size

Required range: 1 <= x <= 1000
​
status
enum<string>

Filter by status

Available options:
open,
active,
muted
​
repo_id
string

Filter by repository ID

​
project_id
string

Filter by project ID

Response

OK

​
has_more
boolean

Indicates if there are more items available

Example:

true

​
items
object[]

The response items

​
next_cursor
string

Cursor for the next page

Example:

"eyJzb3J0X3ZhbHVlIjoiMjAyNC0wMS0xNVQxMDozMDowMFoiLCJkb2N1bWVudF9pZCI6InJlcG8xMjMiLCJzb3J0X2ZpZWxkIjoiY3JlYXRlZF9hdCJ9"

​
total
integer

Total count of items (if available)

Example:

250