# Get a list of scans

Retrieve a list of scans.

Endpoint: GET /api/scans
Version: 24.9.2.5
Security: ApiKeyAuth, Bearer

## Query parameters:

  - `summary` (boolean)
    Return only general information if this parameter is set to true.

  - `limit` (integer)
    Number of scans to return. Can't be greater than 1000.

  - `page` (integer)
    Page number, used in combination with limit.

  - `query` (string)
    Narrow down the query to scans with names matching the parameter value.

  - `sort` (string)
    Field by which to sort the list. Supported values: name, createdTime (default).

  - `order` (string)
    Order direction. Supported values: ascend, descend (default).

  - `filter` (string)
    Filter the scans by status. Comma-separated list of values is accepted, e.g. Finished,Running,Failed.

## Response 200 fields (application/json):

  - `activeCliFeatures` (array)

  - `createdBy` (string)

  - `createdTime` (string)

  - `currentLanguage` (string)

  - `expiration` (string)

  - `groupVisibility` (array)

  - `id` (string)

  - `languages` (array)

  - `lastUpdateTime` (string)

  - `logCtx` (string)

  - `markedForDeletion` (boolean)

  - `message` (string)

  - `metadata` (object)

  - `metadata.applicationName` (string)

  - `metadata.projectName` (string)

  - `name` (string, required)

  - `orgId` (string)

  - `parameters` (object)

  - `parameters.almTrigger` (string)

  - `parameters.configurationId` (string)

  - `parameters.configurationName` (string)

  - `parameters.emailTrigger` (string)

  - `parameters.engineParams` (array)

  - `parameters.engineParams.customFilters` (array)

  - `parameters.engineParams.customFilters.filterId` (string)

  - `parameters.engineParams.customFilters.functionName` (string)

  - `parameters.engineParams.customFilters.paramIndex` (integer)

  - `parameters.engineParams.customFilters.parameterCount` (integer)

  - `parameters.engineParams.customRules` (array)

  - `parameters.engineParams.customRules.description` (string)

  - `parameters.engineParams.customRules.vulnParamIndex` (integer)

  - `parameters.engineParams.customRules.vulnTypeIndex` (integer)

  - `parameters.engineParams.depth` (object)

  - `parameters.engineParams.depth.maxFunctionDepth` (integer)

  - `parameters.engineParams.depth.maxVariableTrack` (integer)

  - `parameters.engineParams.engineId` (integer)

  - `parameters.engineParams.excludedVulnTypes` (array)

  - `parameters.engineParams.severityLevels` (array)

  - `parameters.engineParams.severityLevels.severity` (string)

  - `parameters.engineParams.severityLevels.vulnTypeId` (integer)

  - `parameters.engineParams.trackedInputs` (array)

  - `parameters.engines` (array)

  - `parameters.exclusions` (array)

  - `parameters.ignoreStoredFP` (boolean)

  - `parameters.incremental` (boolean)

  - `parameters.slackTrigger` (string)

  - `parameters.target` (object)

  - `parameters.target.path` (string)

  - `parameters.target.source` (string)

  - `parameters.target.type` (string)

  - `parentAppId` (string)

  - `parentAppName` (string)

  - `platform` (string)

  - `productId` (string)

  - `results` (array)

  - `results.language` (string)

  - `scm` (object)

  - `scm.branch` (object)
    Information about the checked out branch (optional - a commit or a tag may be checked out instead).

  - `scm.branch.name` (string)
    Local branch name.

  - `scm.branch.type` (string)
    Branch type - base or feature branch

  - `scm.branch.upstream` (object)
    Information about an upstream branch tracking the local branch (optional - there may be no upstream).

  - `scm.branch.upstream.branch` (string)
    Name of the upstream branch tracking the local branch.

  - `scm.branch.upstream.isPushed` (boolean)
    Whether the scanned commit was pushed to the upstream branch.

  - `scm.branch.upstream.remoteName` (string)
    Name of the remote associated with this branch. One of the remotes in SCM.Remotes may correspond to it, but it's not guaranteed it
was possible to get that data during analysis.

  - `scm.commit` (object)
    Scanned commit details

  - `scm.commit.Id` (string)
    ID (hash) of the scanned commit.

  - `scm.commit.Time` (string)
    Time of the last commit

  - `scm.openedSubDirectoryPath` (string)

  - `scm.remotes` (array)
    Remotes defined in the repository.

  - `scm.remotes.defaultBranch` (string)
    Introduced for the purposes of Unified Platform migration, can be changed/removed after.

  - `scm.remotes.hasCommit` (boolean)
    Whether the scanned commit was found in the remote.

  - `scm.remotes.name` (string)
    How the remote was named in the repository.

  - `scm.remotes.url` (object)
    URL of the remote.

  - `scm.remotes.url.host` (string)
    With username/password removed.

  - `scm.remotes.url.path` (string)
    With .git suffix removed if it was specified.

  - `scm.remotes.url.port` (integer)
    0 if it wasn't specified in the URL.

  - `scm.remotes.url.scheme` (string)
    ssh for the implicit SSH in scp-like git URL.

  - `startTime` (string)

  - `stats` (object)

  - `stats.critical` (integer)

  - `stats.duration` (string)

  - `stats.high` (integer)

  - `stats.low` (integer)

  - `stats.medium` (integer)

  - `stats.repoDerivedTimeout` (boolean)

  - `stats.resources` (object)

  - `stats.resources.cpu` (integer)

  - `stats.resources.memory` (integer)

  - `stats.resources.os` (string)

  - `stats.testedFiles` (integer)

  - `stats.testedLines` (integer)

  - `stats.timeoutExceeded` (boolean)

  - `stats.totalFiles` (integer)

  - `stats.totalLines` (integer)

  - `stats.totalVulnerabilities` (integer)

  - `status` (string)

  - `versionFlag` (string)

## Response 403 fields (application/json):

  - `message` (string)
    Example: "Something went wrong"

  - `result` (string)
    Example: "error"

  - `success` (boolean)