--- title: "Get work order notes" method: GET path: "/workorders/{workorderId}/notes" tags: ["Notes"] --- # Get work order notes `GET /workorders/{workorderId}/notes` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/workorders/{workorderId}/notes` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns notes and attachments associated with the specified work order. Notes are sorted in descending order by creation date.
Learn more about work order notes in [SCU](https://servicechannel.atlassian.net/wiki/x/4oPNKQ). ## Path parameters - `workorderId` integer, required ## Query parameters - `paging` string ## Response `200` Notes associated with the work order are in the response. - ServiceChannelServicesWebApiModelsResponseNotesGetNotesResponse: Object containing a collection of notes and their counts. - `Notes` ServiceChannelServicesWebApiModelsResponseNotesNoteResponse[]: Notes associated with the specified work order. - `Id` integer: Unique numeric identifier of the work order note. - `DocumentId` string: Unique universal identifier of the work order note. - `Number` integer: Sequential number of the note. - `NoteData` string: Content of the note. - `DateCreated` string, date-time: Date and time when the note was added to the work order. The format is `YYYY-MM-DDThh:mm:ss.sssssssZ`. - `ScheduledDate` string, date-time: Scheduled date of the work order. The format is `YYYY-MM-DDThh:mm:ssZ`. - `FollowUpDate` string, date-time: Follow-up date specified on the note is used to revisit a work order at a later time, for example, to ensure the provider clocked in or updated the work order by the specified date. The format is `YYYY-MM-DDThh:mm:ssZ`. - `ActionRequired` boolean: Indicates whether the recipient of the note is required to take further action on a work order. Check also the `ActionResolveDetails` parameter to see if the issue has been resolved. - `MailedTo` string: Email address(es) to which the note has been sent. - `CreatedBy` string: Describes who created the note. - `CompanyName` string: Name of the subscriber or provider company associated with the note. - `Attachments` ServiceChannelServicesWebApiModelsResponseNotesNoteAttachmentResponse[]: Files added along with the note. - `Id` integer: Unique numeric identifier of the attachment. - `Description` string: Description of the attachment. - `Name` string: Filename of the attachment. - `TimeStamp` string, date-time: Date and time when the attachment was added to the work order or was modified. The format is `YYYY-MM-DDThh:mm:ss.ss`. - `Uri` string: URI of the attachment. - `NoteId` integer: Unique numeric identifier of the note associated with the attachment. - `Visibility` integer: Visibility status of the attachment. Defines which parties can view the attachment. The *PrivateProviderNotesAndAttachments* feature should be enabled. For subscribers who are using Universal Connector, the *PrivateClientNotesAndAttachments* feature should be enabled. Possible values: • `0`: No restrictions on visibility. Visible to everyone. • `1`: Not visible to the client. The subscriber deselected the **Visible to Client** checkmark when uploading an attachment or adding a note with an attachment. • `2`: Not visible to the provider. The subscriber deselected the **Visible to Provider** checkmark when uploading an attachment or adding a note with an attachment. • `3`: Visible to the subscriber only. The subscriber deselected the **Visible to Client** and **Visible to Provider** checkmarks when uploading an attachment or adding a note with an attachment. - `IsInvoiceDigitalCopy` boolean: Indicates whether the attachment is a digital copy of an invoice. Possible response values: `true` and `false`.
Available with the *InvoiceRequireDigitalCopy* feature flag. - `Visibility` string, byte: Defines which parties can view the note. Visibility also works in Universal Connector, where there are three primary parties: *Subscriber*, *External Subscriber*, and *Provider*. Possible response values: • `0`: Visible to everyone (subscriber, external subscriber, provider). • `1`: Visible to the subscriber and the provider. Not visible to the external subscriber. • `2`: Visible to the subscriber and the external subscriber. Not visible to the provider. • `3`: Visible to the subscriber only.
Available with the *PrivateProviderNotesAndAttachments* feature flag. For Universal Connector clients, the *PrivateClientNotesAndAttachments* feature should be turned on. - `NoteType` string: Type of the note: • `SystemNote`: Notes added automatically by the system. • `UsersNote`: Notes posted by users. - `IsAttachmentNote` boolean: Indicates whether the note serves as an attachment note. - `IsPinned` boolean: Indicates whether the note is pinned to the top of the notes list. Possible response values: • `true`: The note is pinned, signifying the most important or pressing note right now for this work order. Only one note can be pinned on a single work order. • `false`: The note isn’t pinned.
Available with the *PinnedNotes* feature flag. - `ActionResolveDetails` ServiceChannelServicesWebApiModelsResponseNotesActionResolveDetailsResponse: Details regarding the resolution status of an action-required note. - `IsResolved` boolean: Indicates whether the action has been resolved. Possible response values: `true` and `false`. Applicable to work order notes that were marked with the **Action Required** flag. - `ResolvedDate` string, date-time: Date and time when the action was resolved. The format is `YYYY-MM-DDThh:mm:ss.ssssss`. - `AllNotesCount` integer: Total count of all notes. - `UserNotesCount` integer: Count of notes created by users. - `SystemNotesCount` integer: Count of system-generated notes. ## Other responses - `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 917 — Invalid work order identifier. Returned if workorderId is <= 0 922 — Invalid paging parameter. Returned if paging parameter doesn't correspond to valid format 922 — Invalid page number 922 — Invalid page size 502 — Work order is not found - `401`: The requested resource requires authentication.
Error codes: 504 — API call rejected by security permissions - `404`: The resource you are looking for has been removed, had its name changed, or is temporarily unavailable. - `500`: Something went wrong, and the server was unable to complete your request.
Error codes: 501 — Internal server error --- [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)