Skip to main content
GET
List Code Scan Profiles

Permissions

Requires a service user or personal access token with the ViewAccountCodeScans permission at the enterprise level.

Behavior

Returns profile summaries (without guidance text) newest first, including both org-owned profiles and profiles shared account-wide (org_id is null for shared profiles). Each summary includes the profile’s mode (discover or ingest) and scan_type, which determine whether it can be passed to Start Code Scan or Start Ingestion Scan. Optionally filter by org_ids; results are paginated with an opaque cursor (after / first). Use Get Code Scan Profile to read a profile’s full guidance. The organization-scoped equivalent is List Code Scan Profiles (Organization).

Authorizations

Authorization
string
header
required

Service User credential (prefix: cog_)

Query Parameters

after
string | null
first
integer
default:100
Required range: 1 <= x <= 200
org_ids
string[] | null

Only return profiles visible to these organizations. Defaults to all organizations in the account.

Response

Successful Response

items
CodeScanProfileSummaryResponse · object[]
required
end_cursor
string | null

Cursor to fetch the next page, or None if this is the last page.

has_next_page
boolean
default:false

Whether there are more items available after this page.

total
integer | null

Optional total count (can be omitted for performance).