---
title: "Get project reports"
method: GET
path: "/v2/Project/{projectId}/Report"
tags: ["Report"]
---

# Get project reports

`GET /v2/Project/{projectId}/Report`

Retrieves a paginated list of SumoQuote Reports related to a SumoQuote Project

## Path parameters

- `projectId` string, uuid, required — The Id of the SumoQuote Project

## Headers

- `X-SQ-Continuation` string, nullable — A pagination token from a last response. If a continuation token is provided, the results will resume from where the last query result set ended

## Response `200`

Success

- SumoReportListPublicApiResponse
  - `message` string, nullable — Information Message
  - `errors` string[], nullable — Error messages
  - `data` SumoReport[], nullable — Request data
    - `reportId` string, nullable
    - `reportDBId` string, uuid
    - `projectDbId` string, uuid
    - `projectIdDisplay` string, nullable
    - `titleReportPage` TitleReportPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `reportType` string, nullable
      - `reportDate` string, date-time, nullable
      - `clientLogoId` string, nullable
      - `primaryImageId` string, nullable
      - `buildingHomeOwnerName` string, nullable
      - `customerFirstName` string, nullable
      - `customerLastName` string, nullable
      - `addressLine1` string, nullable
      - `addressLine2` string, nullable
      - `city` string, nullable
      - `province` string, nullable
      - `postalCode` string, nullable
      - `companyName` string, nullable
      - `customerFullName` string, nullable
    - `executiveSummaryPage` ExecutiveSummaryPage
      - `isVisible` boolean
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `pageIndex` integer
      - `summary` string, nullable
    - `inspectionPage` InspectionPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `inspectionSections` InspectionSection[], nullable
        - `sectionId` integer
        - `sectionTitle` string, nullable
        - `style` 0 | 1 | 2 | 3
        - `inspectionItems` InspectionItem[], nullable
          - `itemId` integer
          - `imageId` string, nullable
          - `summary` string, nullable
    - `authorizationPage` AuthorizationPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `authorizationSections` AuthorizationSection[], nullable
        - `sectionId` integer
        - `sectionTitle` string, nullable
        - `invoiceEnabled` boolean
        - `authorizationItems` AuthorizationItem[], nullable
          - `marginLocked` boolean
          - `price` number, double
          - `quantity` number, double
          - `isTaxExempted` boolean
          - `itemId` integer
          - `itemUUID` string, uuid, nullable
          - `description` string, nullable
          - `selected` boolean
          - `invoiceEnabled` boolean
          - `priceDetailId` string, uuid, nullable
          - `priceDetailName` string, nullable
          - `tierPayments` TierPayment[], nullable
            - `tierId` string, uuid
            - `payment` number, double
      - `productSelections` AuthorizationProductSelection[], nullable
        - `product` string, nullable
        - `selection` string, nullable
        - `id` string, uuid
      - `signatories` Signatory[], nullable
        - `signatoryId` string, uuid
        - `name` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `emailAddress` string, nullable
        - `signingOrder` integer
        - `nameLabel` string, nullable
        - `isPrimary` boolean
        - `fullName` string, nullable
        - `addToCreditApplication` boolean
      - `signatures` SumoPublicQuoteReviewSignatory[], nullable
        - `signatoryId` string, uuid
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `fullName` string, nullable
        - `emailAddress` string, nullable
        - `signingOrder` integer
        - `signature` string, nullable
        - `signatureRequestedOn` string, date-time, nullable
        - `signedOn` string, date-time, nullable
        - `primarySignatory` boolean
        - `customerSignatureConfirmation` boolean
        - `signatoryInitial` SignatoryInitial
          - `termsAcknowledgementRequired` boolean
          - `termsAcknowledged` boolean
          - `termsPageName` string, nullable
          - `termsAcknowledgedDate` string, date-time, nullable
          - `signatoryCustomPageInitials` SignatoryCustomPageInitial[], nullable
            - `customPageIdentifier` string, uuid
            - `acknowledgementRequired` boolean
            - `acknowledged` boolean
            - `acknowledgedDate` string, date-time, nullable
            - `pageName` string, nullable
        - `signingIP` string, nullable
        - `inkSignature` string, nullable
        - `signatureSource` 0 | 1 | 2 | 3
      - `disclaimer` string, nullable
      - `notes` string, nullable
      - `customerNotes` string, nullable
      - `selectionsTitle` string, nullable
      - `inPersonSignature` boolean
      - `manuallySigned` boolean
      - `priceDisplayOption` AuthorizationPriceDisplayOption
        - `displayItemQuantity` boolean
        - `displayItemUnitPrice` boolean
      - `financingTier` string, uuid, nullable
      - `projectDefaultSignatory` Signatory
        - `signatoryId` string, uuid
        - `name` string, nullable
        - `firstName` string, nullable
        - `lastName` string, nullable
        - `emailAddress` string, nullable
        - `signingOrder` integer
        - `nameLabel` string, nullable
        - `isPrimary` boolean
        - `fullName` string, nullable
        - `addToCreditApplication` boolean
      - `depositRequest` PaymentRequest
        - `title` string, nullable
        - `description` string, nullable
        - `dollarAmount` number, double, nullable
        - `percent` number, double, nullable
        - `paymentType` 0
    - `estimateDetailsPage` EstimateDetailsPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `estimateSections` EstimateSection[], nullable
        - `sectionId` integer
        - `sectionTitle` string, nullable
        - `invoiceEnabled` boolean
        - `show` boolean
        - `estimateItems` EstimateItem[], nullable
          - `marginLocked` boolean
          - `price` number, double
          - `quantity` number, double
          - `isTaxExempted` boolean
          - `itemId` integer
          - `itemUUID` string, uuid, nullable
          - `description` string, nullable
          - `invoiceEnabled` boolean
          - `priceDetailId` string, uuid, nullable
          - `priceDetailName` string, nullable
        - `isLockedForAddingItems` boolean
      - `notes` string, nullable
      - `showCustomerPricing` boolean
      - `tieredPricing` boolean
      - `tier1` EstimateTier
        - `tierId` string, uuid
        - `show` boolean
        - `selected` boolean
        - `name` string, nullable
        - `estimateSections` EstimateSection[], nullable
          - `sectionId` integer
          - `sectionTitle` string, nullable
          - `invoiceEnabled` boolean
          - `show` boolean
          - `estimateItems` EstimateItem[], nullable
            - `marginLocked` boolean
            - `price` number, double
            - `quantity` number, double
            - `isTaxExempted` boolean
            - `itemId` integer
            - `itemUUID` string, uuid, nullable
            - `description` string, nullable
            - `invoiceEnabled` boolean
            - `priceDetailId` string, uuid, nullable
            - `priceDetailName` string, nullable
          - `isLockedForAddingItems` boolean
        - `solarSection` SolarSection
          - `systemCost` SystemCost
            - `isPricePerWattVisible` boolean
            - `pricePerWatt` number, double, nullable
          - `description` string, nullable
          - `isTaxExempted` boolean
        - `notes` string, nullable
        - `linkedTier` 1 | 2 | 3
        - `linkedTierDescription` string, nullable
        - `financing` FinancingProduct
          - `source` string, nullable
          - `provider` string, nullable
          - `providerId` string, nullable
          - `friendlySourceName` string, nullable
          - `id` string, nullable
          - `name` string, nullable
          - `loanType` string, nullable
          - `term` number, double
          - `apr` number, double
          - `isACH` boolean, nullable
          - `stateName` string, nullable
          - `minimumLoanAmount` number, double, nullable
          - `maximumLoanAmount` number, double, nullable
          - `productType` string, nullable
          - `tier` integer
          - `defaultPaydown` number, double, nullable
          - `promoTerm` number, double, nullable
          - `promoPercentPayment` number, double, nullable
          - `promoAPR` number, double, nullable
          - `requestedLoanAmount` number, double, nullable
          - `interestType` string, nullable
        - `financingCost` number, double
        - `discountDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `markupDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `showDiscounts` boolean
        - `showMarkups` boolean
      - `tier2` EstimateTier
        - `tierId` string, uuid
        - `show` boolean
        - `selected` boolean
        - `name` string, nullable
        - `estimateSections` EstimateSection[], nullable
          - `sectionId` integer
          - `sectionTitle` string, nullable
          - `invoiceEnabled` boolean
          - `show` boolean
          - `estimateItems` EstimateItem[], nullable
            - `marginLocked` boolean
            - `price` number, double
            - `quantity` number, double
            - `isTaxExempted` boolean
            - `itemId` integer
            - `itemUUID` string, uuid, nullable
            - `description` string, nullable
            - `invoiceEnabled` boolean
            - `priceDetailId` string, uuid, nullable
            - `priceDetailName` string, nullable
          - `isLockedForAddingItems` boolean
        - `solarSection` SolarSection
          - `systemCost` SystemCost
            - `isPricePerWattVisible` boolean
            - `pricePerWatt` number, double, nullable
          - `description` string, nullable
          - `isTaxExempted` boolean
        - `notes` string, nullable
        - `linkedTier` 1 | 2 | 3
        - `linkedTierDescription` string, nullable
        - `financing` FinancingProduct
          - `source` string, nullable
          - `provider` string, nullable
          - `providerId` string, nullable
          - `friendlySourceName` string, nullable
          - `id` string, nullable
          - `name` string, nullable
          - `loanType` string, nullable
          - `term` number, double
          - `apr` number, double
          - `isACH` boolean, nullable
          - `stateName` string, nullable
          - `minimumLoanAmount` number, double, nullable
          - `maximumLoanAmount` number, double, nullable
          - `productType` string, nullable
          - `tier` integer
          - `defaultPaydown` number, double, nullable
          - `promoTerm` number, double, nullable
          - `promoPercentPayment` number, double, nullable
          - `promoAPR` number, double, nullable
          - `requestedLoanAmount` number, double, nullable
          - `interestType` string, nullable
        - `financingCost` number, double
        - `discountDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `markupDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `showDiscounts` boolean
        - `showMarkups` boolean
      - `tier3` EstimateTier
        - `tierId` string, uuid
        - `show` boolean
        - `selected` boolean
        - `name` string, nullable
        - `estimateSections` EstimateSection[], nullable
          - `sectionId` integer
          - `sectionTitle` string, nullable
          - `invoiceEnabled` boolean
          - `show` boolean
          - `estimateItems` EstimateItem[], nullable
            - `marginLocked` boolean
            - `price` number, double
            - `quantity` number, double
            - `isTaxExempted` boolean
            - `itemId` integer
            - `itemUUID` string, uuid, nullable
            - `description` string, nullable
            - `invoiceEnabled` boolean
            - `priceDetailId` string, uuid, nullable
            - `priceDetailName` string, nullable
          - `isLockedForAddingItems` boolean
        - `solarSection` SolarSection
          - `systemCost` SystemCost
            - `isPricePerWattVisible` boolean
            - `pricePerWatt` number, double, nullable
          - `description` string, nullable
          - `isTaxExempted` boolean
        - `notes` string, nullable
        - `linkedTier` 1 | 2 | 3
        - `linkedTierDescription` string, nullable
        - `financing` FinancingProduct
          - `source` string, nullable
          - `provider` string, nullable
          - `providerId` string, nullable
          - `friendlySourceName` string, nullable
          - `id` string, nullable
          - `name` string, nullable
          - `loanType` string, nullable
          - `term` number, double
          - `apr` number, double
          - `isACH` boolean, nullable
          - `stateName` string, nullable
          - `minimumLoanAmount` number, double, nullable
          - `maximumLoanAmount` number, double, nullable
          - `productType` string, nullable
          - `tier` integer
          - `defaultPaydown` number, double, nullable
          - `promoTerm` number, double, nullable
          - `promoPercentPayment` number, double, nullable
          - `promoAPR` number, double, nullable
          - `requestedLoanAmount` number, double, nullable
          - `interestType` string, nullable
        - `financingCost` number, double
        - `discountDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `markupDetails` EstimateDiscountOrMarkupDetails[], nullable
          - `name` string, nullable
          - `type` 0 | 1
          - `dollarAmount` number, double, nullable
          - `percent` number, double, nullable
          - `id` string, nullable
          - `invoiceEnabled` boolean
          - `invoiceHidden` boolean
        - `showDiscounts` boolean
        - `showMarkups` boolean
      - `tiersAreMutuallyExclusive` boolean
      - `priceDisplayOption` EstimatePriceDisplayOption
        - `displayItemQuantity` boolean
        - `displayItemUnitPrice` boolean
        - `displayItemToalPrice` boolean
        - `displaySectionTotalPrice` boolean
      - `financingOptions` ReportFinancingOptions
        - `financingEnabled` boolean
        - `showQuoteTotal` boolean
      - `taxRates` SumoTaxRate[], nullable
        - `name` string, nullable
        - `rate` number, double
        - `required` boolean
        - `taxRateId` string, uuid
    - `termsAndConditionsPage` TermsAndConditionsPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `summary` string, nullable
      - `pdf` SumoPDF
        - `name` string, nullable
        - `id` string, nullable
        - `parentId` string, nullable
        - `folder` string, nullable
      - `summarySelected` boolean
      - `signatoryAcknowledgementRequired` boolean
      - `updatedDate` string, date-time, nullable
    - `warrantyPage` WarrantyPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `details` string, nullable
      - `thanks` string, nullable
      - `signature` string, nullable
      - `signeeName` string, nullable
      - `signeeTitle` string, nullable
      - `startDate` string, date-time, nullable
      - `updatedDate` string, date-time, nullable
    - `customReports` CustomReportPage[], nullable
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `selectedPDF` SumoPDF
        - `name` string, nullable
        - `id` string, nullable
        - `parentId` string, nullable
        - `folder` string, nullable
      - `customPageIdentifier` string, uuid
      - `textPageSelected` boolean
      - `text` string, nullable
      - `signatoryAcknowledgementRequired` boolean
      - `hasSignatoryToken` boolean
    - `invoiceTermsPage` InvoiceTermsPage
      - `isVisible` boolean
      - `pageIndex` integer
      - `pageTitle` string, nullable
      - `change` boolean
      - `canOrder` boolean
      - `excludedFromReport` boolean
      - `terms` string, nullable
      - `notes` string, nullable
    - `sentForSignatureOn` string, date-time, nullable
    - `signature` string, nullable
    - `signatureDate` string, date-time, nullable
    - `signedPDFId` string, nullable
    - `publicQuoteReview` string, uuid, nullable
    - `displayOnPortal` boolean
    - `reportLayoutName` string, nullable
    - `reportLayoutId` string, uuid, nullable
    - `includeInAutoGeneratedRevenue` boolean
    - `totalSignedValue` number, double
    - `totalSignedValueWithTax` number, double
    - `totalSignedUpgradesValue` number, double
    - `totalSignedUpgradesValueWithTax` number, double
    - `metaData` ReportMetadata[], nullable
    - `taxRates` SumoTaxRate[], nullable
      - `name` string, nullable
      - `rate` number, double
      - `required` boolean
      - `taxRateId` string, uuid
    - `signedSumoReportDetail` SignedSumoReport
      - `quoteDetailItems` SumoSignedDetailItem[], nullable
        - `quantity` number, double
        - `unitPrice` number, double
        - `description` string, nullable
        - `isTaxExempted` boolean
        - `priceDetailId` string, uuid, nullable
        - `priceDetailName` string, nullable
        - `material` number, double, nullable
        - `labour` number, double, nullable
        - `markup` number, double, nullable
        - `margin` number, double, nullable
        - `sellingPrice` number, double, nullable
        - `category` integer
        - `quote` string, nullable
        - `section` string, nullable
      - `authorizationItems` SumoSignedOptionalItem[], nullable
        - `quantity` number, double
        - `unitPrice` number, double
        - `description` string, nullable
        - `isTaxExempted` boolean
        - `priceDetailId` string, uuid, nullable
        - `priceDetailName` string, nullable
        - `material` number, double, nullable
        - `labour` number, double, nullable
        - `markup` number, double, nullable
        - `margin` number, double, nullable
        - `sellingPrice` number, double, nullable
        - `category` integer
        - `section` string, nullable
      - `productSelections` AuthorizationProductSelection[], nullable
        - `product` string, nullable
        - `selection` string, nullable
        - `id` string, uuid
      - `totalDiscount` number, double, nullable
      - `totalMarkups` number, double, nullable
      - `totalSignedValue` number, double
      - `totalSignedValueWithTax` number, double
      - `totalSignedUpgradesValue` number, double
      - `totalSignedUpgradesValueWithTax` number, double
      - `totalLabour` number, double
      - `totalMaterial` number, double
      - `totalCost` number, double
      - `totalProfit` number, double
      - `paymentOption` string, nullable
  - `continuation` string, nullable — Continuation Token

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Server Error

---

[API](https://skmtc.net/sumoquote/apis/sumoquote-publicapi.md) · [All operations](https://skmtc.net/sumoquote/apis/sumoquote-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumoquote/sumoquote-publicapi/revisions/08176979e99f/schema)