AfterHours5

AIAgents9

Announcements2

ApplicationAccess1

Assets89

AssetTaskResponse5

AssetTypes25

Attachments31

BatchRfp1

Branding1

Categories6

CheckLists10

Classification2

Compliance5

Contracts5

ContractServiceRates4

Ctools8

Currencies1

DashboardSettings10

EmailNotifications4

Eula2

Feedback7

GlCodes5

Invoices18

IssueList38

LocationNotes2

Locations38

LocationSupply4

MliConfiguration8

MobileTheme7

Notes8

NotificationSubscriptions11

NotificationWebHooks5

OutgoingXml30

Parts10

PlannedMaintenance2

PlatformIntelligence1

Priorities3

Proposals35

ProviderAssignment2

Providers13

PushNotifications4

RefrigerantTracking58

ResolutionCodes8

Rfps6

Roles1

ScConnector10

ServiceRequest10

SingleSignOn4

SiteAudit22

Subscribers10

SupplyClick1

SurveyQuestions5

TemplateFilesHistory1

Trades10

Tradesmen1

Training1

Trucks9

Users15

Weather2

WorkActivities6

WorkOrders65

WorkRequestNote4

WorkRequests14

Notes

Note email recipients

List of email recipients, who can be added to the list of note followers

get/workorders/{workorderId}/notes/recipients

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workorders/:workorderId/notes/recipients/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workorderIdinteger required

Numeric Id of the Work order to perform action with.

Query parameters

showExcludedboolean

If set to true, returns all recipients even those that have 'exclude from note recipient' flag in their setup. False by Default.

noteVisibility'VisibleToEveryone' | 'VisibleToProvider' | 'VisibleToClient' | 'NotVisible'

NoteVisibility.Public is used by default

Response

Request succeeded and the requested information is in the response.

Idinteger

The unique numeric identifier of the user who can be added to the list of email notification recipients.

UserNamestring

The username of the email notification recipient.

Emailstring

The email address of the notification recipient.

RecipientType'Undefined' | 'RegularRecipient' | 'Provider' | 'Follower' | 'LocationNoteRecipient'

Defines the type of the email notification recipient.

Changes

No recorded changes to this operation across all 1 revision of this API.