> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corgea.app/llms.txt
> Use this file to discover all available pages before exploring further.

# スキャン一覧を取得

> 認証済みユーザーの会社に属するスキャンの一覧を取得します



## OpenAPI

````yaml /ja/api-reference/openapi.json get /scans
openapi: 3.0.0
info:
  title: Corgea API
  version: 1.0.0
  description: Corgeaのスキャン機能および脆弱性管理機能を操作するためのAPI
servers:
  - url: https://www.corgea.app/api/v1
    description: 本番サーバー
security:
  - CorgeaToken: []
  - BearerAuth: []
paths:
  /scans:
    get:
      tags:
        - スキャン
      summary: スキャン一覧を取得
      description: 認証済みユーザーの会社に属するスキャンの一覧を取得します
      operationId: getScans
      parameters:
        - name: project
          in: query
          required: false
          schema:
            type: string
          description: プロジェクト名でスキャンを絞り込みます
        - name: repo
          in: query
          required: false
          schema:
            type: string
          description: リポジトリURLの部分文字列でスキャンを絞り込みます
        - name: branch
          in: query
          required: false
          schema:
            type: string
          description: ブランチ名の完全一致でスキャンを絞り込みます
        - name: pull_request_id
          in: query
          required: false
          schema:
            type: string
          description: プルリクエストまたはマージリクエストの識別子の完全一致でスキャンを絞り込みます
        - name: sha
          in: query
          required: false
          schema:
            type: string
          description: コミットSHAの完全一致でスキャンを絞り込みます
        - name: triggered_by
          in: query
          required: false
          schema:
            type: string
          description: スキャンを開始したユーザーで絞り込みます。メールアドレスまたは「current_user」を指定します。
        - name: scan_type
          in: query
          required: false
          schema:
            type: string
            enum:
              - full
              - partial
          description: スキャンタイプで絞り込みます。フルスキャンには「full」、選択したファイルのみのスキャンには「partial」を指定します。
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: ページネーションのページ番号
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 50
          description: 1ページあたりの結果件数
      responses:
        '200':
          description: スキャンを正常に取得しました
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ok
                  page:
                    type: integer
                  total_pages:
                    type: integer
                  total_scans:
                    type: integer
                    description: 全ページを通じてリクエスト条件に一致するスキャンの総数
                  scans:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        engine:
                          type: string
                          example: corgea
                        project:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        repo:
                          type: string
                        branch:
                          type: string
                        status:
                          type: string
                          enum:
                            - scanning
                            - processing
                            - complete
                            - incomplete
                          description: >-
                            スキャンの進行状況。「scanning」と「processing」は実行中、「complete」は完了、「incomplete」は失敗を示します。
                        pull_request_id:
                          type: string
                          nullable: true
                        git_sha:
                          type: string
                          nullable: true
                          description: スキャンに関連付けられたコミットSHA
                        metadata:
                          type: object
                          nullable: true
                          additionalProperties: true
                          description: スキャンに関連付けられたユーザー指定のメタデータ
        '403':
          description: 権限がありません
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Permission denied
components:
  securitySchemes:
    CorgeaToken:
      type: apiKey
      in: header
      name: CORGEA-TOKEN
      description: 認証用のAPIキー
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Authorizationヘッダーで使用するOAuth2アクセストークン（JWT）

````