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

# List builds

> Retrieves a Project's Builds, most recently submitted first. Each entry carries a subset of the fields returned when retrieving a single Build. Supports JSON, newline-delimited JSON (`application/x-ndjson`), and CSV (`text/csv`) response formats via the `Accept` header.



## OpenAPI

````yaml https://api.qlty.sh/openapi.json get /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/builds
openapi: 3.1.0
info:
  title: Qlty API
  version: 1.0.0
  description: >-
    The Qlty API is organized around REST. It provides predictable,
    resource-oriented URLs, accepts JSON-encoded request bodies, and returns
    JSON-encoded responses.
servers:
  - url: https://api.qlty.sh
security:
  - Bearer: []
tags:
  - name: Service
    description: Service status and API discovery operations
  - name: User
    description: Operations for the authenticated user
  - name: Workspaces
    description: Operations for managing workspaces
  - name: Projects
    description: Operations for managing projects
  - name: Issues
    description: Operations for managing issues
  - name: Builds
    description: Operations for retrieving builds
  - name: Metrics
    description: Operations for retrieving metrics
  - name: Components
    description: Operations for retrieving components
  - name: Applications
    description: Operations for managing applications, which group a workspace's projects
  - name: Coverage
    description: Operations for retrieving code coverage data
paths:
  /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/builds:
    get:
      tags:
        - Builds
      summary: List builds
      description: >-
        Retrieves a Project's Builds, most recently submitted first. Each entry
        carries a subset of the fields returned when retrieving a single Build.
        Supports JSON, newline-delimited JSON (`application/x-ndjson`), and CSV
        (`text/csv`) response formats via the `Accept` header.
      operationId: listBuilds
      parameters:
        - schema:
            type: string
            minLength: 3
            example: acme-corp
            description: Repository owner name (login) or workspace ID
          required: true
          description: Repository owner name (login) or workspace ID
          name: ownerKeyOrId
          in: path
        - schema:
            type: string
            minLength: 3
            example: my-repo
            description: Repository name or project ID
          required: true
          description: Repository name or project ID
          name: projectKeyOrId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            example: 20
            description: Maximum number of items to return (1-100)
          required: false
          description: Maximum number of items to return (1-100)
          name: page[limit]
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            example: 0
            description: Number of items to skip
          required: false
          description: Number of items to skip
          name: page[offset]
          in: query
        - schema:
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - submitted
                    - starting
                    - running
                    - succeeded
                    - failed
                    - skipped
                    - rejected
              - type: string
                enum:
                  - submitted
                  - starting
                  - running
                  - succeeded
                  - failed
                  - skipped
                  - rejected
            description: Filter by build status
          required: false
          description: Filter by build status
          name: status
          in: query
      responses:
        '200':
          description: List builds for the project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildList'
              example:
                data:
                  - id: 550e8400-e29b-41d4-a716-446655440000
                    type: analysis
                    status: succeeded
                    branchName: main
                    commitSha: 9c9a4c4a1e6bb01b2fbd7f5e1c0b4a2d3e5f6a7b
                    commitMessage: Fix the bug
                    submittedAt: '2026-01-01T12:00:00Z'
                    finishedAt: '2026-01-01T12:01:35Z'
                    queueSeconds: 5
                meta:
                  hasMore: false
            application/x-ndjson:
              schema:
                type: string
                description: Newline-delimited JSON (NDJSON) format
            text/csv:
              schema:
                type: string
                description: CSV format with header row
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BuildList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BuildSummary'
        meta:
          type: object
          properties:
            hasMore:
              type: boolean
              example: true
              description: Whether there are more items available beyond this page
          required:
            - hasMore
      required:
        - data
        - meta
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
                example: '400'
              title:
                type: string
                example: Bad Request
              detail:
                type: string
                example: The request was invalid.
            required:
              - status
              - title
              - detail
      required:
        - errors
    BuildSummary:
      type: object
      properties:
        id:
          type: string
          example: 550e8400-e29b-41d4-a716-446655440000
        type:
          type: string
          enum:
            - analysis
            - format
            - ssh
            - coverage_setup
          example: analysis
        status:
          type: string
          enum:
            - submitted
            - starting
            - running
            - succeeded
            - failed
            - skipped
            - rejected
          example: succeeded
          description: Most recent status reported for the build
        branchName:
          type: string
          nullable: true
          example: main
        commitSha:
          type: string
          nullable: true
          example: 9c9a4c4a1e6bb01b2fbd7f5e1c0b4a2d3e5f6a7b
        commitMessage:
          type: string
          nullable: true
          example: Fix the bug
        submittedAt:
          type: string
          format: date-time
          example: '2026-01-01T12:00:00Z'
        finishedAt:
          type: string
          nullable: true
          format: date-time
          example: '2026-01-01T12:01:35Z'
        queueSeconds:
          type: integer
          nullable: true
          example: 5
      required:
        - id
        - type
        - status
        - branchName
        - commitSha
        - commitMessage
        - submittedAt
        - finishedAt
        - queueSeconds
      description: A Build as it appears in a list, a subset of Build
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: Generate an API token at https://qlty.sh/user/settings/tokens

````