---
title: "Get site audit reports"
method: GET
path: "/subscribers/current/siteaudit/report"
tags: ["SiteAudit"]
---

# Get site audit reports

`GET /subscribers/current/siteaudit/report`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/subscribers/current/siteaudit/report`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/subscribers/current/siteaudit/report/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a site audit report, its part, or several reports for the current subscriber.
            <br />**Required parameters:**
             • **Option 1**. `auditId`. Use to get a site audit report by ID.
             • **Option 2**. The combination of `fromDate` and `toDate`. Use to get site audit reports for a specific period.
            <br />***Note:*** Site audit reports are also known as *site planning reports* or just *audits*. See [Site Planning Manager](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/551059548/Site+Planning+Manager) for more info.

## Query parameters

- `auditId` integer
- `fromDate` string, date-time
- `toDate` string, date-time
- `country` string
- `locationId` integer
- `area` string

## Response `200`

The requested site audit reports are in the response.

- ServiceChannelServicesMessagingSiteAuditAuditReportExternal[]
  - `TemplateTypeName` string: The site audit type.
  - `AuditId` integer: The numeric identifier of the site audit report.
  - `StoreId` string: The internal identifier of the subscriber’s property.
  - `LocationName` string: The name of the subscriber’s property.
  - `Region` string: The region where the property is located.
  - `District` string: The district where the property is located.
  - `AreaName` string: The name of the audited area within the location.
  - `CheckListName` string: The name of the checklist.
  - `CheckListItemName` string: The name of the checklist item inspected by the auditor.
  - `CheckListItemDescription` string: Detailed instructions for the auditor on how to check or rate the checklist item.
  - `Status` string: This field is obsolete. Use field "Score" with "PassThreshold" and "RatingSystem" fields please.
  - `Score` integer: The score that the auditor gave on the checklist item
  - `PassThreshold` integer: Pass threshold
  - `RatingSystem` string: Rating system
  - `CheckListItemQuantity` string: The quantity of the checklist item or its cost in dollars depending on the `Unit`.
  - `Unit` string: The unit of measure of the checklist item: `Quantity` or `Dollars`.
  - `CheckListDate` string, date-time: The date and time when the auditor completed the audit of the checklist item.
  - `TimeOffset` integer: The UTC offset, or the difference in hours from the UTC time.
  - `UserName` string: The username of the auditor who uploaded the completed audit.
  - `CheckListItemId` integer: The numeric identifier of the checklist item.
  - `AuditStartDate` string, date-time: The date and time when the auditor started the site audit.
  - `AuditFinishDate` string, date-time: The date and time when the auditor completed the site audit.
  - `AuditIssues` ServiceChannelServicesMessagingSiteAuditAuditReportIssueExternal[]
    - `IssueType` string: The type of the action item, either `WO` or `Comment`.
    - `IssueDescription` string: `Comment type`: auditor's comment added to the action item or its attachment. `WO type`: work order description that includes the area, problem type, asset, problem, and auditor’s description of the problem.
    - `AttachmentPaths` string[]: The paths to the attachments added to the checklist item.
    - `IssueId` integer: `Comment type`: numeric identifier of the action item. `WO type`: numeric identifier of the work order, also known as WO tracking number.
    - `WorkOrderPriority` string: The name of the work order priority if the action item belongs to the WO type.
    - `Date` string, date-time: The date and time when the auditor created the action item.

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 1010 - Invalid site audit parameters
- `401`: The request is not authorized. <br/>Error codes: 504 - Missing or incorrect authentication credentials
- `500`: The server was unable to complete the request due to an internal error. <br/>Error codes: 501 - Unspecified internal server error occurred

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)