Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Notes

Get a note

Retrieves the details of a single note (required scope notes:read)

get/v1/notes/{noteId}

Path parameters

noteIdinteger required

The unique identifier of the note

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the note

entityType'contact' | 'job' | 'stockItem' | 'resource' | 'vehicle' | 'salesOpportunity' | 'contract'

The type of entity that the note is associated to<p>Possible values:</p><ul><li><b>contact</b>: Associated with a contact entity</li><li><b>job</b>: Associated with a job entity</li><li><b>stockItem</b>: Associated with a stock item entity</li><li><b>resource</b>: Associated with a resource entity</li><li><b>vehicle</b>: Associated with a vehicle entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>contract</b>: Associated with a contract entity</li></ul>

entityIdinteger

The unique identifier of the associated entity that owns the note, relative to the entityType

contactIdinteger nullable

The unique identifier of the contact associated to this note

typeIdinteger

The unique identifier of the note type definition associated to this note

createdAtstring date-time

The UTC timestamp of when this note was created

subjectstring

The subject of the note

parentIdinteger nullable

The unique identifier of the parent note of this note

dueAtstring date-time nullable

The UTC timestamp of when this note is due for completion

progressedAtstring date-time nullable

The UTC timestamp of when this note was last progressed

referencestring

The internal reference of the note - should usually be unique

status'open' | 'completed' | 'cancelled'

The status of the note<p>Possible values:</p><ul><li><b>open</b>: Open</li><li><b>completed</b>: Completed</li><li><b>cancelled</b>: Cancelled</li></ul>

descriptionstring

The detailed textual content about the note

completionTextstring nullable

A textual note that can be added when a note has been completed. Can only be set if the note has a completed status

progressPercentageinteger

The percentage of work done required to complete the note

createdByUserNamestring

The name of the user who owns the note

ownedByUserIdinteger

The unique id of the user who owns the note

ownedByUserNamestring

The name of the user who owns the note

Example response

{
  "id": 5514123,
  "entityType": "contact",
  "entityId": 5514123,
  "contactId": 47644689,
  "typeId": 5514123,
  "createdAt": "2022-11-29T16:50:16.0000000+00:00",
  "subject": "Call Mr Brown",
  "parentId": 5514123,
  "dueAt": "2022-11-29T16:50:16.0000000+00:00",
  "progressedAt": "2022-11-29T16:50:16.0000000+00:00",
  "reference": "5514123",
  "status": "open",
  "description": "Message left by Mr Brown regarding the recent installation of his CCTC cameras. He can't get one of them working and needs some technical support.",
  "completionText": "Called the customer, he is now happy with the work",
  "progressPercentage": 50,
  "createdByUserName": "Mr. Jones",
  "ownedByUserId": 1245,
  "ownedByUserName": "Mr. Smith",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "Purple",
      "definition": {
        "caption": "Favourite colour",
        "type": "boolean",
        "listOptions": [
          "Red",
          "Blue",
          "Green",
          "Purple"
        ],
        "isRequired": true,
        "isEditable": true,
        "default": "10"
      },
      "systemListValueMetadata": {
        "label": "John Doe",
        "entityType": "resource"
      }
    }
  ]
}