Skip to main content
GET
/
api
/
v1
/
scans
List scans
curl --request GET \
  --url https://app.gecko.security/api/v1/scans \
  --header 'X-API-Key: <api-key>'
{
  "version": "v1",
  "data": [
    {
      "id": "f5d35de5-8fc8-4a01-8e28-3bae5d6d26ad",
      "name": "Sample Scan",
      "status": "completed",
      "isDone": true,
      "createdAt": "2025-04-22T15:34:53.674Z",
      "endAt": "2025-04-22T16:08:22.115Z",
      "programmingLanguage": "TypeScript",
      "progress": 100,
      "vulnerabilityCounts": {
        "total": 42,
        "critical": 3,
        "high": 11,
        "medium": 20,
        "low": 8
      }
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  },
  "filters": {
    "status": "completed",
    "language": "typescript"
  }
}

Authorizations

​
X-API-Key
string
header
required

Team-scoped Gecko API key. Keys start with gk_.

Query Parameters

​
status
string

Filter scans by status.

​
language
string

Filter scans by programming language.

​
limit
integer
default:100

Maximum number of results to return. Gecko defaults to 100 and caps the value at 1000.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of results to skip before Gecko starts returning rows.

Required range: x >= 0

Response

A paginated list of scans.

​
version
string
required
Allowed value: "v1"
​
data
object[]
required
​
pagination
object
required
​
filters
object
required