Project overview (scans + open handoff count)

GET

/projects/{id}/overview

const url = 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/overview?scan_limit=15';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/overview?scan_limit=15' \
  --header 'Authorization: Bearer <token>'

Single response for project detail shell: open handoff count, scan totals, last scan, mismatch summary, recent scans. Non-superadmin scan queries are scoped by account_id.

Authorizations

bearerApiKey
cookieAuth

Parameters

Path Parameters

required

string format: uuid

Project UUID

Query Parameters

scan_limit

integer

default: 15 >= 1 <= 50

Max recent scan rows in recent_scans

Responses

200

Overview payload

application/json

object

project_id

required

string format: uuid

open_handoff_count

required

integer

scan_total_count

required

integer

last_scan_at

string | null format: date-time

last_scan_status

string | null

mismatch_count

required

integer

recent_scans

required

Array<object>

Scan row subset (id, status, scanned_at, summary, trigger_source, duration_ms)

object

400

Invalid request

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number