How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ServiceChannel SiteAudit API

The SiteAudit API from ServiceChannel — 18 operation(s) for siteaudit.

ServiceChannel SiteAudit API is one of 66 APIs that ServiceChannel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Site Audit. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 22 operations across 18 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version bearer.v1.

Requests are made against a single base URL, https://sb2fixxbook.servicechannel.com:443/api.

22 operations 18 paths 59 schemas 1 DELETE14 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
bearer.v1
Base URL
https://api.servicechannel.com/v3
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ServiceChannel SiteAudit API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • oauth2 — OAuth2 Authorization

Paths & Operations 22

Across 18 paths, the API surfaces 22 operations — 1 DELETE, 14 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

SiteAudit 22
GET
/subscribers/current/locations/{locationId}/siteaudit/templateTypes
Get available audit types for specified location
GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes 1 param → 200
GET
/subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfo
Get audit data for specified location and audit type
GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfo 2 params → 200
POST
/subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfo
Post (save) completed audit to the database
POSTv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfo 2 params body → 200
GET
/subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfoWeighted
Get audit data for specified location and audit type for new templates
GETv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfoWeighted 2 params → 200
POST
/subscribers/current/locations/{locationId}/siteaudit/templateTypes/{templateTypeId}/auditInfoWeighted
Post (save) completed audit of new type to the database
POSTv3_subscribers_current_locations_{locationId}_siteaudit_templateTypes_{templateTypeId}_auditInfoWeighted 2 params body → 200
POST
/subscribers/current/locations/auditInfo
Save completed audit to the database
POSTv3_subscribers_current_locations_auditInfo body → 200400401500
GET
/subscribers/current/locations/auditinfo
Get audit data for specified location and audit type without template information
GETv3_subscribers_current_locations_auditinfo?locationId={locationId}&templateId={templateId} 2 params → 200400401500
GET
/subscribers/current/locations/auditinfo/checklist/templates
Get checklist templates by audit template.
GETv3_subscribers_current_locations_auditinfo_checklist_templates?templateId={templateId} 1 param → 200400401500
GET
/subscribers/current/locations/auditinfo/checklistitem/templates
Get checklistitem templates by audit template.
GETv3_subscribers_current_locations_auditinfo_checklistitem_templates?templateId={templateId}&checkListTemplateId={checkListTemplateId} 2 params → 200400401500
GET
/subscribers/current/siteaudit/checkListItems/{checkListItemId}
Get details for specified checklist item
GETv3_subscribers_current_siteaudit_checkListItems_{checkListItemId} 1 param → 200401500
GET
/subscribers/current/siteaudit/audits/completed
Get completed site audits
GETv3_subscribers_current_siteaudit_audits_completed?daysPeriod={daysPeriod} 1 param → 200401500
GET
/subscribers/current/siteaudit/report
Get site audit reports
GETv3_subscribers_current_siteaudit_report?auditId={auditId}&fromDate={fromDate}&toDate={toDate}&country={country}&locationId={locationId}&area={area} 6 params → 200400401500
GET
/subscribers/current/siteaudit/completed/{auditId}
Get information on a completed audit
GETv3_subscribers_current_siteaudit_completed_{auditId} 1 param → 200400401404500
PUT
/subscribers/current/siteaudit/completed
Modify details of a completed audit
PUTv3_subscribers_current_siteaudit_completed body → 200400401404500
POST
/subscribers/current/siteaudit/completed
Save completed audit to the database
POSTv3_subscribers_current_siteaudit_completed body → 201400401500
GET
/subscribers/current/siteaudit/{auditId}
Get site audit by Id
GETv3_subscribers_current_siteaudit_{auditId} 1 param → 200400401404500
PUT
/subscribers/current/siteaudit/open
Update audit with open status
PUTv3_subscribers_current_siteaudit_open body → 200400401404500
POST
/subscribers/current/siteaudit/open
Save audit with open status to the database
POSTv3_subscribers_current_siteaudit_open body → 201400401500
GET
/subscribers/current/siteaudit/audits/filtered
Get the list of filtered site audits
GETv3_subscribers_current_siteaudit_audits_filtered?searchValue={searchValue}&status={status}&pageIndex={pageIndex}&pageSize={pageSize}&startDate={startDate}&endDate={endDate} 6 params → 200401500
DELETE
/subscribers/current/siteaudit/open/{auditId}
Remove open audit
DELETEv3_subscribers_current_siteaudit_open_{auditId} 1 param → 200400401404500
GET
/subscribers/current/locations/checkAuditInfo
Check if the site audit can be created
GETv3_subscribers_current_locations_checkAuditInfo?locationId={locationId}&templateTypeId={templateTypeId} 2 params → 200400401500
GET
/subscribers/current/siteaudit/{auditId}/linkedWorkOrderIds
Get an array of workOrderIDs linked to the Site Audit
GETv3_subscribers_current_siteaudit_{auditId}_linkedWorkOrderIds 1 param → 200401500

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.SiteAudit.AuditReportExternal (23 properties), ServiceChannel.Services.Messaging.SiteAudit.SavedCheckListItemExternal (16 properties), ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditCheckListItem (15 properties), ServiceChannel.Services.Messaging.SiteAudit.UpdatedCheckListItemExternal (14 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditDataExternal
object
Parameters for updating general audit info.
9 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedCheckListExternal
object
Parameters for updating the checklist.
5 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListExternal
object
4 properties
ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditInfo
object
10 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListTemplateExternal
object
3 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditIssueAttachmentExternal
object
Parameters for updating the attachments added to the checklist item.
4 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditDataWeightedExternal
object
8 properties
ServiceChannel.Services.Messaging.SiteAudit.QuantityExternal
object
3 properties
System.Object
object
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemExternal
object
12 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedAuditIssueExternal
object
Comment added to the checklist item.
7 properties
ServiceChannel.Services.Messaging.SiteAudit.CompletedAuditListResponse
object
Object containing general info on completed audits.
4 properties
ServiceChannel.Services.Messaging.SiteAudit.WorkOrder
object
5 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditReportIssueExternal
object
The details of issues created by the auditor for the inspected checklist item. Issues are also known as action items.
6 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedCheckListItemExternal
object
Parameters for updating the checklist items.
14 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedCheckListExternal
object
Information on the checklists.
5 properties
ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditCheckListItem
object
15 properties
ServiceChannel.Services.Messaging.SiteAudit.PreviousAuditQuantityModelExternal
object
2 properties
ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditCheckList
object
5 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemRequest
object
12 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemStatisticExternal
object
9 properties
ServiceChannel.Services.Messaging.SiteAudit.PreviousAuditInfoModelExternal
object
13 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditAreaExternal
object
Parameters for updating the areas.
4 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemDetailsResponse
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.GetAuditInfo
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditAreaRequest
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemStatisticWeightedExternal
object
10 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedOpenAuditResponse
object
2 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditTypeExternal
object
Object containing information on audit template types.
3 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditAreaExternal
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListRequest
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemWeightedExternal
object
13 properties
ServiceChannel.Services.Messaging.SiteAudit.CompletedAuditInfoExternal
object
Object containing audit details.
6 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedCompletedAuditResponse
object
Object containing response parameters.
2 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditQuantityExternal
object
Parameters for updating the quantity or dollar cost of the inspected checklist items.
4 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternal
object
11 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListExternalOld
object
6 properties
ServiceChannel.Services.Messaging.SiteAudit.LocationExternal
object
Object containing location details.
10 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedAuditIssueAttachmentExternal
object
Checklist item attachments.
7 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditReportExternal
object
The site audit report object. Depending on the features enabled for your company, the object structure may differ from the example below.
23 properties
ServiceChannel.Services.Messaging.SiteAudit.UpdatedAuditIssueExternal
object
Parameters for updating the comment added to the checklist item.
5 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListWeightedExternal
object
6 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditInfoExternal
object
Object containing audit details.
8 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedAuditAreaExternal
object
Information on the inspected areas.
4 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedAuditQuantityExternal
object
Quantity or dollar cost of the inspected checklist items.
3 properties
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.IssueAttachmentExternal
object
7 properties
ServiceChannel.Services.RequestHandlers.SiteAudit.CompletedAuditArea
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditIssueExternal
object
6 properties
ServiceChannel.Services.RequestHandlers.SiteAudit.GetFilteredAuditListResponse
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditAreaWeightedExternal
object
5 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedCheckListItemExternal
object
Information on the inspected checklist items.
16 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditDataExternalOld
object
7 properties
ServiceChannel.Services.Messaging.SiteAudit.AuditAreaExternalOld
object
5 properties
ServiceChannel.Services.Messaging.SiteAudit.SavedAuditInfoExternal
object
General details of a completed audit.
11 properties
ServiceChannel.Services.Messaging.SiteAudit.PreviousAuditIssueModelExternal
object
4 properties
ServiceChannel.Services.Messaging.SiteAudit.CheckListItemExternalOld
object
12 properties
ServiceChannel.Services.Messaging.SiteAudit.SaveAuditDataResponse
object
3 properties
ServiceChannel.Services.Messaging.SiteAudit.PreviousAuditIssueAttachmentModelExternal
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-siteaudit-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
ServiceChannel AIAgents API
ServiceChannel Announcements API
ServiceChannel ApplicationAccess API
ServiceChannel Assets API
ServiceChannel AssetTaskResponse API
ServiceChannel AssetTypes API
ServiceChannel Attachments API
ServiceChannel BatchRfp API
ServiceChannel Branding API
ServiceChannel Categories API
ServiceChannel CheckLists API
Where this information came from

This is an independent, third-party profile of ServiceChannel SiteAudit API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.