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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ServiceChannel

ServiceChannel WorkOrders API

The WorkOrders API from ServiceChannel — 70 operation(s) for workorders.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Work Orders. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 75 operations across 70 paths, and defines 147 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.

75 operations 70 paths 147 schemas 3 DELETE32 GET11 POST29 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 WorkOrders 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 75

Across 70 paths, the API surfaces 75 operations — 3 DELETE, 32 GET, 11 POST, 29 PUT. Each is listed below with its method, path, parameters, and response codes.

WorkOrders 75
GET
/workorders
Search Work Orders
GETv3_workorders?locationId={locationId}&storeId={storeId} 20 params → 200400401500
POST
/workorders
Create a Work order
POSTv3_workorders body → 201400401500
PUT
/workorders/{workorderId}/status
Update a Work order Status
PUTv3_workorders_{workorderId}_status 1 param body → 200400401500
PUT
/workorders/{workorderId}/priority
Update Work order Priority
PUTv3_workorders_{workorderId}_priority 1 param body → 200400401500
PUT
/workorders/{workorderId}/category
Update the work order category
PUTv3_workorders_{workorderId}_category 1 param body → 200400401500
PUT
/workorders/{workorderId}/nte
Update Work order NTE
PUTv3_workorders_{workorderId}_nte 1 param body → 200400401500
PUT
/workorders/{workOrderId}/projectApproval
Update Work orders NTE project approval
PUTv3_workorders_{workOrderId}_projectApproval 1 param body → 200400401500
POST
/workorders/{workOrderId}/projectApproval
Create Work orders project approval
POSTv3_workorders_{workOrderId}_projectApproval 1 param body → 200400401500
PUT
/workorders/{workorderId}/scheduledate
Update Work order Scheduled Date
PUTv3_workorders_{workorderId}_scheduledate?rescheduleReasonCode={rescheduleReasonCode} 2 params body → 200400401500
PUT
/workorders/{workorderId}/description
Update Work order Description
PUTv3_workorders_{workorderId}_description 1 param body → 200400401500
PUT
/workorders/{workorderId}/trade
Change Work order Trade
PUTv3_workorders_{workorderId}_trade 1 param body → 200400401500
POST
/workorders/{workorderId}/resolution
Add Work order Resolution
POSTv3_workorders_{workorderId}_resolution 1 param body → 201400401500
PUT
/workorders/{workorderId}/caller
Update Work order Caller
PUTv3_workorders_{workorderId}_caller 1 param body → 200400401500
PUT
/workorders/{workorderId}/ponumber
Update Work order Purchase Number
PUTv3_workorders_{workorderId}_ponumber 1 param body → 200400401500
PUT
/workorders/{workOrderId}/projectedCompletionDate
Update Work Order Projected Completion Date
PUTv3_workorders_{workOrderId}_projectedCompletionDate 1 param body → 200400401500
PUT
/workorders/{workorderId}/wonumber
Update Work order Number
PUTv3_workorders_{workorderId}_wonumber 1 param body → 200400401500
PUT
/workorders/{workorderId}/projectid
Update ProjectId
PUTv3_workorders_{workorderId}_projectid 1 param body → 200400401500
PUT
/workorders/{workorderId}/projectid/unlink
Unlink ProjectId
PUTv3_workorders_{workorderId}_projectid_unlink 1 param → 200400401500
PUT
/workorders/{workorderId}/weatherTypeId
Update weather type
PUTv3_workorders_{workorderId}_weatherTypeId?subscriberId={subscriberId} 2 params body → 200400401500
PUT
/workorders/{workorderId}/issueChoice
Update issue choice on WO
PUTv3_workorders_{workorderId}_issueChoice?subscriberId={subscriberId}&locationId={locationId} 3 params body → 200400500
PUT
/workorders/{workorderId}/reassign
Reassign Work Order
PUTv3_workorders_{workorderId}_reassign 1 param body → 200400401403
GET
/workorders/reassign/reasons
Work order reassignment reasons
GETv3_workorders_reassign_reasons?subscriberId={subscriberId} 1 param → 200400401403
GET
/workorders/{workorderId}
Retrieve a Work order
GETv3_workorders_{workorderId} 1 param → 200400401404
GET
/workorders/issueinfo/{workorderId}
Retrieve a Work order related information
GETv3_workorders_issueinfo_{workorderId} 1 param → 200400401404
GET
/workorders/{workorderId}/validateCheckIn
Validate Check-In action
GETv3_workorders_{workorderId}_validateCheckIn?WorkTypeId={WorkTypeId}&Latitude={Latitude}&Longitude={Longitude} 4 params → 200400401405
GET
/workorders/{workorderId}/validateCheckOut
Validate Check-Out action
GETv3_workorders_{workorderId}_validateCheckOut?WorkTypeId={WorkTypeId}&Latitude={Latitude}&Longitude={Longitude} 4 params → 200400401405
POST
/workorders/{workorderId}/universalCheckIn
Perform a check-in
POSTv3_workorders_{workorderId}_universalCheckIn 1 param body → 200400401405
POST
/workorders/{workorderId}/universalCheckOut
Perform a check-out
POSTv3_workorders_{workorderId}_universalCheckOut 1 param body → 200400401405
GET
/workorders/{workOrderId}/checklists-responses
Get checklist responses for a work order
GETv3_workorders_{workOrderId}_checklists-responses?getAll={getAll} 2 params → 200400401500
POST
/odata/workorders/filter
Retrieve work orders
POSTv3_odata_workorders_filter body → 200401406500
GET
/workorders/statistics
Statistics Collection
GETv3_workorders_statistics?daysPeriod={daysPeriod} 1 param → 200400401
GET
/workorders/categories
Categories Collection
GETv3_workorders_categories?SubscriberId={SubscriberId}&SortExpr={SortExpr} 2 params → 200400401
GET
/workorders/statuses
Get work order statuses
GETv3_workorders_statuses?subscriberId={subscriberId}&tradeId={tradeId} 2 params → 200400401
GET
/workorders/{workorderId}/statuses
Get work order statuses that relate to a specific work order.
GETv3_workorders_{workorderId}_statuses?subscriberId={subscriberId}&tradeId={tradeId} 3 params → 200400401
GET
/workorders/starred
Starred Work Order Ids Collection
GETv3_workorders_starred → 200400401
GET
/workorders/label
Get work order labels
GETv3_workorders_label?keyword={keyword}&page={page}&pageSize={pageSize} 3 params → 200400401
PUT
/workorders/{workorderId}/label
Update a work order label
PUTv3_workorders_{workorderId}_label 1 param body → 200400401500
DELETE
/workorders/{workorderId}/label
Delete a work order label
DELETEv3_workorders_{workorderId}_label 1 param body → 200400401
POST
/workorders/labels
Create work order labels
POSTv3_workorders_labels body → 200400401403500
PUT
/workorders/{workorderId}/labels
Add labels to work order
PUTv3_workorders_{workorderId}_labels 1 param body → 200400401403404500
DELETE
/workorders/{workorderId}/labels
Delete labels from work order
DELETEv3_workorders_{workorderId}_labels 1 param body → 200400401403404500
PUT
/workorders/{workorderId}/servicenowid
Update work order servicenowid
PUTv3_workorders_{workorderId}_servicenowid 1 param body → 200400401403
POST
/workorders/{workorderId}/addstripecharge
Create Stripe charge
POSTv3_workorders_{workorderId}_addstripecharge 1 param body → 200400401500
PUT
/workorders/{workorderId}/link
Creates link between two Work Orders
PUTv3_workorders_{workorderId}_link?workorderIdToLink={workorderIdToLink} 2 params body → 204400401
PUT
/workorders/{workorderId}/unlink
Removes link between two Work Orders
PUTv3_workorders_{workorderId}_unlink?linkedWorkorderId={linkedWorkorderId} 2 params body → 204400401
POST
/workorders/{workorderId}/feedback
Leave feedback for a work order
POSTv3_workorders_{workorderId}_feedback 1 param body → 200400401
GET
/workorders/feedback/list
Get work orders feedbacks
GETv3_workorders_feedback_list?workOrdersIds[0]={workOrdersIds[0]}&workOrdersIds[1]={workOrdersIds[1]} 1 param → 200400401
GET
/workorders/providerforreassignment
Retrieve a Provider
GETv3_workorders_providerforreassignment?workorderId={workorderId}&providerId={providerId}&locationId={locationId}&trade={trade} 4 params → 204400401
POST
/workorders/solvedissue
Submit solved issue during troubleshooting
POSTv3_workorders_solvedissue body → 201400401404
GET
/worktypes
Work types Collection
GETv3_worktypes?subscriberId={subscriberId} 1 param → 200400401
GET
/workorders/{workorderId}/techniciansAssigned
Retrieve list of technicians assigned to the specified work order
GETv3_workorders_{workorderId}_techniciansAssigned 1 param → 200401403404500
GET
/workorders/{workorderId}/refrigerantUseStatus
Retrieve the status of refrigerant use on a work order
GETv3_workorders_{workorderId}_refrigerantUseStatus 1 param → 200401404
GET
/workorders/{workOrderId}/leakWasDetected
Retrieve the leak detection result on a work order
GETv3_workorders_{workOrderId}_leakWasDetected 1 param → 200400401404
PUT
/workorders/{workorderId}/markRefrigerantUse
Update the status of refrigerant use on a work order
PUTv3_workorders_{workorderId}_markRefrigerantUse?refrigerantWasUsed={refrigerantWasUsed}&actor={actor} 3 params → 204400401404
PUT
/workorders/{workOrderId}/UpdateWorkOrderLeakInspectionInfo
Update the leak inspection information
PUTv3_workorders_{workOrderId}_UpdateWorkOrderLeakInspectionInfo?refrigerantWasUsed={refrigerantWasUsed}&leakWasDetected={leakWasDetected} 3 params → 204400401404
GET
/workorders/{workOrderId}/weatherEvent
Get the Weather Event associated to a work order (if set)
GETv3_workorders_{workOrderId}_weatherEvent?subscriberId={subscriberId} 2 params → 200400401
PUT
/workorders/{workorderId}/SetMoeNumber
Mark if refrigerant was used
PUTv3_workorders_{workorderId}_SetMoeNumber?moeNumber={moeNumber} 2 params → 200400401404
GET
/workorders/{workorderId}/features
Checks features of Work order subscriber
GETv3_workorders_{workorderId}_features?features[0]={features[0]}&features[1]={features[1]} 2 params → 200400401502
GET
/workorders/{workOrderId}/analytics
Get analytics on a work order
GETv3_workorders_{workOrderId}_analytics 1 param → 200401404500
GET
/workorders/isTechnicianCertificateUsedOnWorkOrders
Check if the certificate is linked to WOs
GETv3_workorders_isTechnicianCertificateUsedOnWorkOrders?certificateId={certificateId} 1 param → 200400401500
PUT
/workorders/{workOrderId}/technicianCertificate
Assign the tech’s certificate to the work order
PUTv3_workorders_{workOrderId}_technicianCertificate 1 param body → 200400401404500
PUT
/workorders/{workOrderId}/accept
Accept a work order
PUTv3_workorders_{workOrderId}_accept 1 param body → 200400401404500
PUT
/workorders/{workOrderId}/decline
Decline a work order
PUTv3_workorders_{workOrderId}_decline 1 param body → 200400401500
GET
/workorders/{workOrderId}/checklistFailureState
Gets the work order checklist failure state.
GETv3_workorders_{workOrderId}_checklistFailureState 1 param → 200401404500
GET
/workorders/{workorderId}/GPSRadius
Retrieve a GPS radius for a work order
GETv3_workorders_{workorderId}_GPSRadius 1 param → 200400401
POST
/workorders/{workorderId}/followers
Add Followers to Work order
POSTv3_workorders_{workorderId}_followers 1 param body → 201400401404
DELETE
/workorders/{workorderId}/followers
Remove Follower from Work order
DELETEv3_workorders_{workorderId}_followers?email={email} 2 params → 200400401404
PUT
/subscribers/{subscriberId}/workorders/{workorderId}/reassign
PUTv3_subscribers_{subscriberId}_workorders_{workorderId}_reassign 2 params → 200401404
GET
/odata/workorders
Retrieve work orders
WorkOrders_GetWorkOrders 7 params → 200400401502
GET
/odata/workorders({workorderId})
Retrieve a Work Orders
WorkOrders_Get 8 params → 200
GET
/odata/workorders({workorderId})/Service.CheckInActivity(loadBlocked={loadBlocked})
Retrieve a Work Order CheckIn Activity
WorkOrders_CheckInActivity 9 params → 200
GET
/odata/locations({locationId})/workorders
Retrieve a Work Orders
WorkOrders_GetWorkOrdersForLocation 8 params → 200
GET
/odata/locations({locationId})/workorders/Service.GetDuplicates()
Retrieve a Duplicate Work Orders
WorkOrders_GetDuplicateWorkOrders 8 params → 200
GET
/odata/locations({locationId})/workorders/Service.GetRecalls()
Retrieve Work Order Recalls
WorkOrders_GetRecallWorkOrders 8 params → 200
GET
/odata/workorders/Service.NearBy(latitude={latitude},longitude={longitude})
Retrieve a Work Orders near by a site.
WorkOrders_GetWorkOrdersNearBy 9 params → 200

Schemas 147

The contract defines 147 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.Workorders.WorkOrder (79 properties), ServiceChannel.Services.Messaging.Assets.AssetResponse (70 properties), ServiceChannel.Services.Messaging.Invoices.Invoice (69 properties), ServiceChannel.Services.Messaging.Workorders.CreateWoRequest (60 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.CountDescriptor
object
Count descriptor information.
2 properties
ServiceChannel.Services.Messaging.Workorders.CheckOutRequest
object
Check-out request
15 properties 2 required
ServiceChannel.Services.Messaging.Workorders.GetWorkOrderLabelResponse
object
Object containing the details of labels
2 properties
ServiceChannel.Services.Messaging.Workorders.AssigneeUser
object
2 properties
ServiceChannel.Services.Messaging.Users.LimitOptions
object
Object for NTE, proposal, and invoice limits set for a subscriber user.
3 properties
ServiceChannel.Services.Messaging.Workorders.WeatherEvent
object
2 properties
ServiceChannel.Data.FieldValue
object
2 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCodeGroup
object
5 properties
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.CheckListDetailQuestionsExtendedResponse
object
Checklist question details.
18 properties
ServiceChannel.Services.Messaging.Users.DashboardInfo
object
Dashboard details object.
3 properties
ServiceChannel.Services.Messaging.Workorders.AddStripeChargeRequest
object
AddStripeCharge request
3 properties 3 required
ServiceChannel.Services.Messaging.Workorders.ChangeWoProjectIdRequest
object
3 properties 1 required
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WorkOrder
object
Workorder object for Messages exchange.
56 properties
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.ChecklistQuestionNumericType
object
The object defines the failure criteria used to evaluate answers for the Numeric Input question
5 properties
ServiceChannel.Services.Messaging.Notes.NoteInfo
object
9 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderStatusResponse
object
2 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderStatus
object
3 properties 2 required
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.UpdateWorkOrderResolutionResponse
object
Object containing the details of the modified work order resolution.
1 property
ServiceChannel.Services.Messaging.Invoices.InvoiceTravel
object
Information on the trip.
10 properties
ServiceChannel.Services.WebApi.Models.Request.WorkOrder.UpdateWorkOrderProjectedCompletionDateRequest
object
2 properties 1 required
ServiceChannel.Services.Messaging.Assets.Warranty
object
Object containing warranty parameters.
9 properties
ServiceChannel.Services.Messaging.Invoices.Invoice
object
69 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWoFieldsRequest
object
Request to update the value of a work order parameter.
2 properties 1 required
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.CheckListResponseExtended
object
Object for checklist response details.
21 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceMaterial
object
Information on the materials used. Add a separate object for each material.
18 properties
ServiceChannel.Services.Messaging.ApprovalCodes.AdditionalApprovalCodeOption
object
2 properties
ServiceChannel.Services.WebApi.Models.Request.Labels.DeleteWorkOrderLabelsRequest
object
Request object for removing labels from a work order.
2 properties 1 required
ServiceChannel.Api.Model.Workorders.OverrideProperties.Anomaly
object
11 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrderLabelRequest
object
Object containing information about the work order label
3 properties
ServiceChannel.Services.Messaging.Workorders.CheckInIActivity
object
18 properties
ServiceChannel.Services.Messaging.Invoices.StatusHistoryShort
object
5 properties
ServiceChannel.Services.Messaging.Assets.WarrantyExpiration
object
Object containing warranty expiration details.
2 properties
ServiceChannel.Services.Messaging.CountDescriptor
object
2 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrderAnalyticsResponse
object
3 properties
ServiceChannel.Services.Messaging.Users.User
object
User details object.
17 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.Location
object
Location associated with a work order.
18 properties
ServiceChannel.Services.Messaging.Currencies.Currency
object
7 properties
ServiceChannel.Services.Messaging.Workorders.LinkWorkordersRequest
object
Link Workorders Request
2 properties
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.CheckListAcknowledgeUrlResponse
object
2 properties
ServiceChannel.Services.Messaging.Notes.NotesDescriptor
object
3 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WorkOrderStatus
object
Status of a work order.
3 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse
object
Object containing the details of the modified work order.
1 property
ServiceChannel.Services.Messaging.Workorders.AddFollowersRequest
object
2 properties 2 required
ServiceChannel.Services.Messaging.ODataRequest
object
7 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceAmountsDetails
object
Object containing the list of the invoice charges.
6 properties
ServiceChannel.Api.Model.Proposals.MlpLevelSimpleModel
object
10 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrder
object
Workorder object for Messages exchenge.
79 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.EquipmentAttributeDescription
object
Equipment attribute description.
12 properties
ServiceChannel.Services.Messaging.Workorders.AcceptWorkOrderRequest
object
Request model to add a note to the work order while accepting it.
1 property
ServiceChannel.Services.WebApi.Models.Request.WorkOrder.ReassignWorkOrder.ReassignWorkOrderRequest
object
Reassign WorkOrder To other Provider
30 properties 2 required
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest
object
CreateWoRequest
60 properties 5 required
ServiceChannel.Services.Messaging.Attachments.AddAttachmentRequest
object
8 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceOther
object
The invoices material
14 properties
ServiceChannel.Services.Messaging.V4.Workorders.WorkTypeResponse
object
WorkTypeResponse
2 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.NoteInfo
object
Information about a note.
8 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrderReassignmentReason
object
Work Orders Reassignment reason response
3 properties
ServiceChannel.Services.WebApi.Models.Response.Labels.AddWorkOrderLabelsResponse
object
1 property
ServiceChannel.Services.Messaging.Workorders.ChangeWoNteRequest
object
5 properties
ServiceChannel.Services.Messaging.Invoices.InvoicePaymentResponse
object
Object containing the invoice payment details.
5 properties
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.Assets.WarrantyProvider
object
Object containing warranty provider details.
3 properties
ServiceChannel.Services.Messaging.Users.UserInfo
object
The user details object.
6 properties
ServiceChannel.Services.Messaging.Workorders.GetGPSRadiusResponse
object
GPS radius object.
5 properties
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest.Material
object
9 properties
ServiceChannel.Services.WebApi.Models.Request.UpdateWorkOrderResolutionRequest
object
2 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.AttachmentsDescriptor
object
Attachments descriptor information.
1 property
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WarrantyExpiration
object
Object containing warranty expiration details.
2 properties
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest.DispatchSettings
object
describes email notification settings on work order creation
7 properties
ServiceChannel.Services.Messaging.LocationNote.LocationNote
object
Object with the location note details.
4 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderStatusDescriptor
object
3 properties
ServiceChannel.Services.Messaging.Workorders.Dashboard.Requests.SubmitSolvedIssueModel
object
Problem solve model
13 properties 2 required
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.ChecklistPictureResponse
object
Object for an attachment added to a checklist response.
7 properties
ServiceChannel.Services.WebApi.Models.Request.WorkOrder.ReassignWorkOrder.AdditionalApprovalCodeRequest
object
8 properties
ServiceChannel.Services.Messaging.CheckInOut.CheckInOutResponse
object
Check In/Out Response
1 property
ServiceChannel.Services.Messaging.RefrigerantTracking.AddWorkOrderPartRefrigerantItem
object
Object for adding part use records in bulk
28 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceCategoryMessaging
object
2 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrderStatisticsResponse
object
Work Orders Statistics responce
4 properties
DecisionAnswer
object
2 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WarrantyProvider
object
Object containing warranty provider details.
2 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCode
object
10 properties
ServiceChannel.Services.Messaging.Workorders.WorkOrderLabelResponse
object
Parameters of labels
2 properties
ServiceChannel.Services.Messaging.Workorders.CreateWorkOrdersProjectApprovalRequest
object
2 properties 2 required
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.LocationNote
object
Object with the location note details.
2 properties
ServiceChannel.Services.Messaging.Workorders.IssueChoiceRequest
object
7 properties
ServiceChannel.Services.Messaging.Workorders.GetStatusResponse
object
Object containing the details of the available work order statuses.
5 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.UpdateWorkOrderProjectedCompletionDateResponse
object
1 property
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest.ExtendedRequestInfo
object
ExtendedRequestInfo
13 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.ChecklistFailureState
object
Object containing the work order checklist failure state information.
1 property
ServiceChannel.Services.Messaging.Workorders.UnlinkWorkordersRequest
object
Unlink Workorders Request
2 properties
ServiceChannel.Services.WebApi.Models.Request.WorkOrder.ReassignWorkOrder.AdditionalApprovalCodeOptionRequest
object
2 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.Subscriber
object
Subscriber associated with a work order.
4 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceLabor
object
Information on labor. Add a separate object for each worker. When two or more workers have the same SkillLevel,LaborType, and HourlyRate, use one object and sp…
16 properties
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.GetResponsesByWorkOrderResponse
object
Object for checklist responses submitted for a work order.
1 property
ServiceChannel.Api.Model.Workorders.WorkOrderLabel
object
2 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderExtendedStatus
object
Object containing the list of available extended statuses for a specific primary status.
2 properties
ServiceChannel.Services.Messaging.Workorders.NteDetails
object
4 properties
ServiceChannel.Services.Messaging.RefrigerantTracking.AssetRefrigerant
object
37 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWoStatusRequestExt
object
5 properties 1 required
ServiceChannel.Services.Messaging.Workorders.LeaveFeedbackRequest
object
2 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWoTechnicianCertificateRequest
object
Object containing the tech’s certificate ID.
1 property
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.Currency
object
Currency information.
3 properties
ServiceChannel.Services.WebApi.Models.Request.Labels.AddWorkOrderLabelsRequest
object
Request object for adding labels to a work order
2 properties 1 required
ServiceChannel.Api.Model.Workorders.WeatherEventType
object
3 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderStatusExt
object
3 properties 2 required
ServiceChannel.Services.Messaging.Workorders.ContractInfo
object
ContractInfo (composite object) - describes who, where and what will perform as well as the one who requested work
7 properties 3 required
ServiceChannel.Services.Messaging.Assets.AssetAttributesMap
object
4 properties
ServiceChannel.Services.Messaging.Users.MliUserInfo
object
3 properties
ServiceChannel.Services.Messaging.Workorders.DeclineWorkOrderRequest
object
Request model to add information about the work order decline
3 properties
ServiceChannel.Services.Messaging.Workorders.ChangeWoWeatherTypeIdRequest
object
1 property 1 required
ServiceChannel.Services.Messaging.Invoices.InvoiceTaxesDetails
object
Object containing the list of taxes. You can add taxes as a fixed amount or as a percentage.
10 properties
ServiceChannel.Services.Messaging.Workorders.WorkorderStatusConstraints
object
Object containing rules and limits that apply to a work order when it’s in a given status.
6 properties
System.Object
object
ServiceChannel.Services.Messaging.Workorders.UpdateWorkOrdersProjectApprovalRequest
object
2 properties 2 required
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest.AdditionalField
object
Service Request Additional Field (Name, Value) pairs
2 properties
ServiceChannel.Services.Messaging.Invoices.Tax2Details
object
Information on the additional tax. Only invoices for Canadian locations can have Tax2Details.
2 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WorkOrderLabel
object
The label associated with a work order.
2 properties
ServiceChannel.Services.Messaging.Category.CategoryResponse
object
Object containing the details of the available categories.
6 properties
ServiceChannel.Services.Messaging.Invoices.InvoiceApprovalCodeChild
object
11 properties
ServiceChannel.Services.Messaging.Users.AccessOptions
object
Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and…
4 properties
ServiceChannel.Services.Messaging.Attachments.AttachmentsDescriptor
object
1 property
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.IssueTicketInfo
object
Issue ticket information.
2 properties
ServiceChannel.Services.Messaging.IdentityObject
object
1 property
ServiceChannel.Services.Messaging.Workorders.UpdateLabelResponse
object
Object containing the details of the modified work order
1 property
ServiceChannel.Services.Messaging.Workorders.WorkOrderServiceNowIdRequest
object
1 property
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.Provider
object
Provider associated with a work order.
6 properties
ServiceChannel.Services.Messaging.ApprovalCodes.EditableAdditionalApprovalCode
object
9 properties
ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.ChecklistQuestionOptionResponse
object
Answer option configured for a checklist question of the Selector type.
5 properties
ServiceChannel.Services.Messaging.ApplicationAccess.FeatureResponse
object
Feature response entity.
1 property
ServiceChannel.Services.Messaging.Assets.AssetResponse
object
Object details of an asset.
70 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.Warranty
object
Object containing warranty parameters.
8 properties
ServiceChannel.Services.Messaging.Location.Location
object
General location details object.
45 properties
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.AssetResponse
object
Object details of an asset.
49 properties
ServiceChannel.Services.Messaging.Workorders.CreateWoRequest.IssueRequest
object
4 properties 1 required
ServiceChannel.Services.Messaging.Workorders.ChangeWoCategoryRequest
object
3 properties 1 required
ServiceChannel.Services.Messaging.RefrigerantTracking.RefrigerantUseReasonCode
object
Object containing refrigerant use reasons.
6 properties
ServiceChannel.Services.Messaging.Users.Limit
object
Object for limit details set for a subscriber user.
2 properties
ServiceChannel.Services.Messaging.Users.MlpUserInfo
object
3 properties
ServiceChannel.Services.Messaging.Equipments.EquipmentAttributeDescription
object
12 properties
ServiceChannel.Services.Messaging.Subscribers.Subscriber
object
19 properties 1 required
ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.NotesDescriptor
object
Notes information for a work order.
3 properties
ServiceChannel.Services.Messaging.CheckInOut.CheckInValidateResponse
object
Check-In Validate Response
9 properties
ServiceChannel.Services.Messaging.Providers.Provider
object
34 properties
ServiceChannel.Services.WebApi.Models.Response.Labels.CreateWorkOrdersLablesResponse
object
1 property
ServiceChannel.Services.Messaging.Workorders.CheckInRequest
object
Check-in request
7 properties 2 required
ServiceChannel.Services.WebApi.Models.Request.Labels.CreateWorkOrdersLabelsRequest
object
Request object for adding labels for a subscriber.
1 property 1 required
ServiceChannel.Services.Messaging.IssueLists.IssueTicketInformation
object
8 properties
ServiceChannel.Services.WebApi.Models.Response.Labels.DeleteWorkOrderLabelsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-workorders-api-openapi.yml Raw ↑

Other APIs ServiceChannel publishes across the network.

ServiceChannel AfterHours API
AE Profile APIs.io
ServiceChannel AIAgents API
AE Profile APIs.io
ServiceChannel Announcements API
AE Profile APIs.io
ServiceChannel ApplicationAccess API
AE Profile APIs.io
ServiceChannel Assets API
AE Profile APIs.io
ServiceChannel AssetTaskResponse API
AE Profile APIs.io
ServiceChannel AssetTypes API
AE Profile APIs.io
ServiceChannel Attachments API
AE Profile APIs.io
ServiceChannel BatchRfp API
AE Profile APIs.io
ServiceChannel Branding API
AE Profile APIs.io
ServiceChannel Categories API
AE Profile APIs.io
ServiceChannel CheckLists API
AE Profile APIs.io
#Work Orders
← Back to S APIs
API Details
ID
servicechannel:servicechannel-workorders-api
Base URL
https://api.servicechannel.com/v3
Docs
https://developer.servicechannel.com/swagger/ui/index?version=3
Provider
ServiceChannel
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=servicechannel-workorders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/servicechannel-workorders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ServiceChannel WorkOrders 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.