---
title: "Retrieve a list of scans."
method: GET
path: "/v1/scan"
tags: ["Scan"]
---

# Retrieve a list of scans.

`GET /v1/scan`

## Request

- Base URL: `https://help.puppet.com/api/public`
- URL: `https://help.puppet.com/api/public/v1/scan`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/puppet/apis/puppet-comply-api/docs/v1/scan/get.ts> (a function with typed inputs; its response is checked against the schema)

To use this endpoint, you must have one of the following roles:
`comply-admin`
`comply-operator`
`comply-viewer`

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

ScanListResponse is the response for a scan list.

- object
  - `data` Scan[], required: Data contains list of scans records.
    - `created_at` string, date-time, required: The time at which the scan was created.
    - `errored` integer, required: The number of nodes that errored in scan.
    - `failed` integer, required: The number of nodes that failed in scan.
    - `finished` integer, required: The number of nodes that finished in scan.
    - `finished_at` string, date-time, nullable: The time at which the scan finished.
    - `id` string, required: The ID of the scan.
    - `name` string, required: The name of the scan.
    - `nodes_scanned` integer, required: The number of nodes scanned.
    - `status` 'started' | 'finished' | 'failed', required: The status of the inventory sync job.
    - `type` string, required: The type of scan.
  - `limit` integer: If specified limit, you retrieve a subset of records limited to the given value..
  - `next` string, nullable: Next page value .
  - `offset` integer: Offset is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value.
  - `total` integer, required: Total number of records.

## Other responses

- `default`: ErrorResponse is the default error response.

---

[API](https://skmtc.dev/puppet/apis/puppet-comply-api.md) - [All operations](https://skmtc.dev/puppet/apis/puppet-comply-api/llms.txt) - [OpenAPI document](https://skmtc.dev/puppet/apis/puppet-comply-api/revisions/0a7ac90117d7?raw)