Get Case Notes

Description

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

Service Name	Get Case Notes
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/v2/case/{caseID}/notes
Production URL	https://integration.himarley.io/api/v2/case/{caseID}/notes
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
• Common Errors to Handle
  • [404] Case Not Found

API Request

Flow

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

Request Example

https://integration.uat.marley.ai/api/case/c808ba82-e2cb-4a92-9344-b924d79d2308/notes

 

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.

 

API Response 

Response Payload Example

{
   "notes": [
     {
      "archived": false,
      "mentionedUserIds": [
      "643bb2f8-f82d-4e71-94f0-fad78172024a"
            ],
       "authorId": "643bb2f8-f82d-4e71-94f0-fad78172024a",
      "plainText": "Note deletion test @KevinRoller",
      "replies": [],
      "id": "a9bed973-c8ac-4c59-96ae-2fc09055943e",
      "status": 200
     },
     {
      "archived": false,
      "mentionedUserIds": [
      "643bb2f8-f82d-4e71-94f0-fad78172024a"
      ],
      "authorId": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
      "plainText": "Hello @KevinRoller this is a test (again)",
      "replies": [
                  {
                     "archived": false,
                     "mentionedUserIds": [
                           "643bb2f8-f82d-4e71-94f0-fad78172024a"
                                         ],
                    "authorId": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
                    "plainText": "Hello @KevinRoller this is a test (again)",
                    "id": "1b6e5320-db96-459a-b473-26e6a71228b1"
                   }
               ],
      "id": "3195e5bd-0a8b-4684-a9de-745e77cc38c4",
      "status": 200
      },
      {
       "archived": false,
       "mentionedUserIds": [
              "d7827444-ff66-420a-a6af-62016ccbe3b6"
                            ],
       "authorId": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
       "plainText": "Hello @StevenColon this is a test",
       "replies": [],
       "id": "5c9e6fe8-f058-408a-a890-ef367a5f22cd",
       "status": 200
       }
   ]
}

 

Response Fields Breakdown

Property	Element	Description	Type	Example
archived		Indicates whether the note has been archived or not. Will be false for new notes and true for deleted notes.	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 body of the 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. Can be used for other case note API endpoints.	string	"id": "05b620d7-d4f6-46fa-b1d0-ede778b0fd99"