Get Case Note by Note ID

Description

This endpoint returns a single case note on a Hi Marley case associated to the Case ID value passed in the request.

Service Name	Get Case Note by Note ID
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/case/{caseID}/notes/{noteID}
Production URL	https://integration.himarley.io/api/v2/case/{caseID}/notes/{noteID}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response 
  • Response Payload Example
  • Response Fields Breakdown

API Request

Flow

1. Send API request with the path parameter of the Hi Marley Case ID and Note ID.
2. Hi Marley receives the request and validates the Case ID and Note ID exist.
3. Hi Marley responds with the Note data associated with the passed Case ID and Note value.

Request Example

https://integration.uat.marley.ai/api/case/c808ba82-e2cb-4a92-9344-b924d79d2308/
notes/bf1559f6-7f57-4d07-bb18-5a7eb986310e

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The Case ID associated with the Hi Marley case	string	true	c808ba82-e2cb-4a92-9344-b924d79d2308	caseId exists within Hi Marley.
noteId		The Note ID within the Hi Marley case	string	true	bf1559f6-7f57-4d07-bb18-5a7eb986310e	noteId exists within the Hi Marley case

 

API Response 

Response Payload Example

{
"archived": false,
"mentionedUserIds": [
"643bb2f8-f82d-4e71-94f0-fad78172024a"
         ],
"plainText": "Note deletion test @KevinRoller",
"replies": [],
"id": "a9bed973-c8ac-4c59-96ae-2fc09055943e"
}

 

Response Fields Breakdown

Property	Element	Description	Type	Example
archived		Indicates whether the note has been deleted or not.	boolean	"archived": false
mentionedUserIds	id	Hi Marley internally generated id of the mentioned user	array	"mentionedUserIds": [ "5bfa662f-2026-4bfa-be39-57a8ae7b083f" ]
authorId	id	Hi Marley internally generated id of the author	string	"authorId": "643bb2f8-f82d-4e71-94f0-fad78172024a"
plainText		The message body of the case note.	string	"plainText": "Hello @ExampleUser"
replies		This field will list any responses to your note. Replies will have the same properties and formatting as original case note.	string	"replies": []
id	id	The note id for the note that was retrieved.	string	"id": "05b620d7-d4f6-46fa-b1d0-ede778b0fd99"