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 Notes API

The Notes API from ServiceChannel — 6 operation(s) for notes.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 8 operations across 6 paths, and defines 13 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.

8 operations 6 paths 13 schemas 1 DELETE4 GET1 PATCH2 POST

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 Notes 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 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Notes 8
GET
/workorders/{workorderId}/notes
Get work order notes
GETv3_workorders_{workorderId}_notes?paging={paging} 2 params → 200400401404500
POST
/workorders/{workorderId}/notes
Create a work order note
POSTv3_workorders_{workorderId}_notes 1 param body → 201400401403500
GET
/workorders/{workorderId}/notes/recipients
Note email recipients
GETv3_workorders_{workorderId}_notes_recipients?showExcluded={showExcluded}¬eVisibility={noteVisibility} 3 params → 200400401404
POST
/workorders/{workorderId}/notes/followers
Add Followers to Work order notes
POSTv3_workorders_{workorderId}_notes_followers 1 param body → 201400404
DELETE
/workorders/{workorderId}/notes/followers
Remove Follower from Work order notes
DELETEv3_workorders_{workorderId}_notes_followers?email={email} 2 params → 200400404
PATCH
/workorders/{workorderId}/notes/{noteId}
Partially update a work order note
PATCHv3_workorders_{workorderId}_notes_{noteId} 2 params body → 200400401403404500
GET
/odata/workorders({workorderId})/notes
Retrieve work order notes
Notes_GetWorkOrderNotes 8 params → 200400404
GET
/odata/workorders({workorderId})/notes({noteId})
Get a work order note by note ID
Notes_GetWorkOrderNote 9 params → 200400404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ServiceChannel.Services.Messaging.Notes.Note (18 properties), ServiceChannel.Services.WebApi.Models.Response.Notes.NoteResponse (17 properties), ServiceChannel.Services.Messaging.Workorders.CreateWoNoteRequest (12 properties), ServiceChannel.Services.Messaging.Attachments.Attachment (9 properties). Each schema is shown below with its type and property counts.

ServiceChannel.Services.WebApi.Models.Response.Notes.NoteResponse
object
Object containing note details.
17 properties
ServiceChannel.Services.Messaging.Attachments.Attachment
object
Object containing information about an attachment.
9 properties
ServiceChannel.Services.WebApi.Models.Request.Notes.PartialUpdateWorkOrderNoteRequest
object
Object for pinning/unpinning the work order note.
1 property
ServiceChannel.Services.Messaging.Notes.ActionResolveDetails
object
Details regarding the resolution status of an action-required note.
2 properties
ServiceChannel.Services.Messaging.Workorders.CreateWoNoteRequest
object
Represents a request to create a work order note.
12 properties 1 required
ServiceChannel.Services.Messaging.Workorders.AddFollowersRequest
object
2 properties 2 required
ServiceChannel.Services.WebApi.Models.Response.Notes.GetNotesResponse
object
Object containing a collection of notes and their counts.
4 properties
ServiceChannel.Services.Messaging.Notes.EmailRecipientResponse
object
The email notification recipient object.
4 properties
ServiceChannel.Services.WebApi.Models.Response.Notes.ActionResolveDetailsResponse
object
Details regarding the resolution status of an action-required note.
2 properties
System.Object
object
ServiceChannel.Services.WebApi.Models.Response.Notes.NoteAttachmentResponse
object
Represents the response details of a note attachment.
8 properties
ServiceChannel.Services.Messaging.ErrorResponse
object
The error response object
4 properties
ServiceChannel.Services.Messaging.Notes.Note
object
Object containing notes for the specified work order ID.
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

servicechannel-notes-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
#Notes
← Back to S APIs
API Details
ID
servicechannel:servicechannel-notes-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-notes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/servicechannel-notes-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 Notes 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.