companies/{cid}/notes (get)
Retrieves the notes attached to a company. Notes are simple plain text.
Optionally a user can attach "labels" to each not to further qualify the content. Labels must of course be customized first in the web interface: Go to "Settings" then "Labels" and finally "Notes".
URL
(GET) /companies/{cid}/notes
PARAMETERS
The URL parameters are:
cid | The company ID | int, Mandatory |
RESULTS
An array of JSON objects. Each element is a note and has these properties:
id | The timezone of the user. This is a string identifier. | int |
refid | The ID of the company to which this note is attached. | int |
text | The actual text of the note (plain text) | string |
labels | An array with labels assigned to the note. Each array element has these properties:
If there are no labels, the array is empty. | object[] |
change | An object with information about who and when edited this note: | |
change.uid | The ID of the user who has added or modified this note. | int |
change.cid | The ID of the changing user's company | int |
change.unm | The name of the changing user (first + last name) | string |
change.cnm | The name of the changing company | string |
change.date | The date when this note was added or changed | datetime |
EXAMPLE
A sample result: