Skip to main content
GET
/
v2
/
projects
Get projects
curl --request GET \
  --url https://api.ghostsecurity.ai/v2/projects \
  --header 'Authorization: Bearer <token>'
{
  "has_more": true,
  "items": [
    {
      "business_criticality": "<string>",
      "cast_scan_enabled": true,
      "components": [
        {
          "criticality": 123,
          "description": "<string>",
          "folder_name": "<string>",
          "type": "<string>"
        }
      ],
      "created_at": "<string>",
      "dependencies_file": "<string>",
      "deployment_usage": "<string>",
      "deployments": {},
      "enabled": true,
      "evidence": "<string>",
      "exposure": "<string>",
      "file_extensions": [
        "<string>"
      ],
      "findings_count": 123,
      "frameworks": [
        "<string>"
      ],
      "has_custom_metadata": true,
      "id": "<string>",
      "languages": [
        "<string>"
      ],
      "last_committed_at": "<string>",
      "last_scan_id": "<string>",
      "last_scan_status": "<string>",
      "last_scanned_at": "<string>",
      "organization_id": "<string>",
      "owner": "<string>",
      "primary_framework": "<string>",
      "primary_language": "<string>",
      "provider": "<string>",
      "purpose": "<string>",
      "relative_path": "<string>",
      "repo": {
        "id": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "scanner_business_criticality": "<string>",
      "scanner_exposure": "<string>",
      "scanner_summary": "<string>",
      "sensitive_data_types": [
        "<string>"
      ],
      "size": 123,
      "summary": "<string>",
      "updated_at": "<string>",
      "user_business_criticality": "<string>",
      "user_exposure": "<string>",
      "user_summary": "<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,
last_committed_at
​
order
enum<string>
default:desc

Sort order

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

Page size

Required range: 1 <= x <= 1000

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