---
title: "Get site audit by Id"
method: GET
path: "/subscribers/current/siteaudit/{auditId}"
tags: ["SiteAudit"]
---

# Get site audit by Id

`GET /subscribers/current/siteaudit/{auditId}`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/subscribers/current/siteaudit/{auditId}`
- 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/:auditId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `auditId` integer, required

## Response `200`

The requested site audit info is in the response.

- ServiceChannelServicesMessagingSiteAuditSavedAuditInfoExternal: General details of a completed audit.
  - `Id` integer: Unique numeric identifier of the site audit.
  - `StoreId` integer: Unique numeric identifier of the location where the site audit was conducted.
  - `UserId` integer: Unique numeric identifier of the user (auditor) who conducted the site audit.
  - `UserName` string: Display name of the user (auditor) who conducted the site audit.
  - `TemplateTypeId` integer: Unique numeric identifier of the template that was used to complete the site audit. The template determines the audit type.
  - `StartDate` string, date-time: Date and time when the user started the audit in the SC Mobile app or in Service Automation. The format is `YYYY-MM-DDThh:mm:ss.ss`.
  - `FinishDate` string, date-time: Date and time when the site audit was completed. The format is `YYYY-MM-DDThh:mm:ss.ss`.
  - `FinishDateStr` string: Date when the site audit was completed. The format is `MMM DD, YYYY`.
  - `Status` 'Undefined' | 'Open' | 'Completed': Unique numeric identifier of the status. Possible response values: • `1`: The site audit status is *Open*. • `2`: The site audit status is *Completed*.
  - `Emails` string: Email address(es) to which the audit results were sent out by the auditor upon completing the audit.
  - `Areas` ServiceChannelServicesMessagingSiteAuditSavedAuditAreaExternal[]: List of areas that were inspected during the site audit, for example, *Interior* or *Exterior*.
    - `Id` integer: Unique numeric identifier of the area that was inspected.
    - `Name` string: Area name, for example, *Exterior* or *Interior*.
    - `SortOrder` integer: Sorting order of the area.
    - `CheckLists` ServiceChannelServicesMessagingSiteAuditSavedCheckListExternal[]
      - `Id` integer: Unique numeric identifier of the checklist.
      - `Name` string: Checklist name, for example, *Restroom* or *Dining room*.
      - `Unlisted` boolean
      - `SortOrder` integer: Sorting order of the checklist.
      - `CheckListItems` ServiceChannelServicesMessagingSiteAuditSavedCheckListItemExternal[]
        - `Id` integer: Unique numeric identifier of the checklist item.
        - `Name` string: Item name, for example, *Hand dryer* or *Sink*.
        - `Description` string: Detailed description/instruction for the checklist item.
        - `Score` integer: Shows how the checklist item was rated. The response value depends on the rating system applied. • `-1`: The item was marked as **Not applicable**. • `1`: In the **Pass/Fail** rating system, it stands for the **Fail** answer. • `2`: In the **Pass/Fail** rating system, it stands for the **Pass** answer. • `numeric value`: In the **Weighted** rating system, a custom numeric value is assigned to each option: **Good**, **Fair**, and **Fail**. • `0–10`: In the **Numeric** rating system, a value from 0 to 10 can be used to rate the item. • `0–100`: In the **Percentage** rating system, a value from 0% to 100% can be used to rate the item.
        - `System` integer: Rating system that was applied to the checklist item. Possible response values: • `1`: For the **Pass/Fail** rating system • `2`: For the **Numeric** rating system • `3`: For the **Weighted** rating system • `4`: For the **Percentage** rating system. When this rating system is used, the `Score` value is displayed in percentages. <br />Learn more about each rating system in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/550928611/Building+a+Site+Audit+in+an+Excel+Template).
        - `Date` string, date-time: Date and time when the checklist item was inspected and rated. The format is `YYYY-MM-DDThh:mm:ss.sss`.
        - `DateStr` string: Date when the checklist item was inspected and rated. The format is `MMM DD, YYYY`.
        - `Unlisted` boolean
        - `CheckListItemImpact` string: Checklist item’s impact on the total audit score. Possible response values: • `Veto`: Means that this item has the highest impact on the audit score. When at least one of the veto checklist items is rated as **Fail**, the total score of the audit drops to 1%. • `Ignore`: Means that this item is ignored when the audit score is calculated. • `Empty value`: When the method returns an empty value, it means that this checklist item is counted as a regular item.
        - `UseNumericRatingSystem` boolean
        - `PassThreshold` integer: Minimum rating value that is sufficient to pass the audit. Can be in numbers or percentages based on the rating system applied to the checklist item. See the `System` parameter.
        - `Range` integer[]: Range of numbers displayed to the user during the audit, allowing the auditor to rate the item. Permits selecting a score on a 0–10 scale or from 0% to 100%.
        - `Issues` ServiceChannelServicesMessagingSiteAuditSavedAuditIssueExternal[]
          - `Id` integer: Comment ID.
          - `Date` string, date-time: Date and time when the comment was added to the checklist item. The format is `YYYY-MM-DDThh:mm:ss.ss`.
          - `DateStr` string: Date when the comment was added to the checklist item. The format is `MMM DD, YYYY`.
          - `Description` string: Comment added to the checklist item during the audit.
          - `Persistent` boolean: Shows whether or not the comment should be saved for future audits. Possible response values: • `true`: When the auditor sets the corresponding toggle in the SC Mobile app or in Service Automation to save the checklist item comment for future audits. • `false`: When the comment should not be preserved and displayed for future audits.
          - `UserName` string: Username of the auditor who added the comment to the checklist item during the inspection.
          - `Attachments` ServiceChannelServicesMessagingSiteAuditSavedAuditIssueAttachmentExternal[]
            - `Id` integer: Attachment ID.
            - `FileName` string: File name of the attachment.
            - `RemoteName` string: Remote name of the attached file.
            - `RemoteNameResized` string: Attachment file name that has been resized.
            - `ContentType` string: Type of the attached file, for example, *image* or *video*.
            - `ContentUrl` string: Web address (or Uniform Resource Locator) that points to the attached file.
            - `ContentUrlResized` string: Web address (or Uniform Resource Locator) that points to the resized version of the original image.
        - `WorkOrderIds` integer[]: Tracking numbers of the work orders created in the event of the checklist item inspection.
        - `Quantity` ServiceChannelServicesMessagingSiteAuditSavedAuditQuantityExternal: Quantity or dollar cost of the inspected checklist items.
          - `Id` integer: Quantity record ID.
          - `Value` integer: Value showing either the quantity or the dollar amount of the items that have been inspected.
          - `Unit` string: Shows whether the auditor captured the **Quantity** or the **Dollar Cost** of the inspected item. Possible response values: `Quantity` and `Dollars`.
        - `PreviousAuditInfoList` ServiceChannelServicesMessagingSiteAuditPreviousAuditInfoModelExternal[]
          - `Id` integer
          - `Date` string
          - `Score` integer
          - `AreaName` string
          - `CheckListName` string
          - `ItemName` string
          - `Range` integer[]
          - `PassThreshold` integer
          - `System` integer
          - `Comments` ServiceChannelServicesMessagingSiteAuditPreviousAuditIssueModelExternal[]
            - `Date` string
            - `Comment` string
            - `UserName` string
            - `Attachments` ServiceChannelServicesMessagingSiteAuditPreviousAuditIssueAttachmentModelExternal[]
              - …
          - `WorkOrderIds` integer[]
          - `Quantity` ServiceChannelServicesMessagingSiteAuditPreviousAuditQuantityModelExternal
            - `Value` integer
            - `Unit` string
          - `CanBeExpanded` boolean

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 608 - Do not have access to the location
- `401`: The request is not authorized. <br/>Error codes: 504 - Missing or incorrect authentication credentials
- `404`: The requested resource does not exist on the server. <br/>Error codes: 1008 - Audit not found
- `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)