ZUzuper

Get Customer Generic Notes

Changed on
get/v2/customer_portal/notes

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/v2/customer_portal/notes
  • Auth
    API key in header x-api-key

Query parameters

module'JOB' | 'INVOICE' | 'ESTIMATE' | 'REQUEST' | 'PROPERTY' required
module_uidstring required
sort'DESC' | 'ASC'
sort_by'created_at'

Response

200

typestring

Example response

{
  "type": "success",
  "data": [
    {
      "note_uid": "a1961153-d4df-4f65-9ac1-6dce167aff18",
      "note_type": "TEXT",
      "attachments": [
        {
          "attachment_name": "test",
          "attachment": "test",
          "attachment_type": "TEXT",
          "attachment_size": 10,
          "_id": "66f731b327283fab7aa80dd3"
        }
      ],
      "created_by_type": "CUSTOMER",
      "visible_to_customer": true,
      "created_at": "2024-09-27T22:29:07.894Z"
    }
  ]
}

Changes