Skip to main content
GET
/
scans
Get Scans
curl --request GET \
  --url https://www.corgea.app/api/v1/scans \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "status": "ok",
  "page": 123,
  "total_pages": 123,
  "scans": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "engine": "corgea",
      "project": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "repo": "<string>",
      "branch": "<string>",
      "pull_request_id": 123
    }
  ]
}

Authorizations

​
CORGEA-TOKEN
string
header
required

API key for authentication

Query Parameters

​
project
string

Filter scans by project name

​
repo
string

Filter scans by repository URL substring

​
branch
string

Filter scans by exact branch name

​
pull_request_id
string

Filter scans by exact pull request or merge request identifier

​
triggered_by
string

Filter scans by the user who triggered them. Use an email address or "current_user".

​
scan_type
enum<string>

Filter scans by type. Use "full" for full scans or "partial" for scans limited to selected files.

Available options:
full,
partial
​
page
integer
default:1

The page number for pagination

​
page_size
integer
default:20

The number of results per page

Required range: x <= 50

Response

Scans retrieved successfully

​
status
string
Example:

"ok"

​
page
integer
​
total_pages
integer
​
scans
object[]