API Version 1.2
API Documentation for developers
Getting list of contact notes
URL: /api/notes.format
Method: GET
Overview:
Resource which contains all notes and deals (deal is a kind of note in the system) for given contact.
| Name | Type | Description |
| cid | string | Contact ID |
| Name | Type | Description |
| id | string | Note ID |
| cid | string | Contact ID |
| body | string | Note body |
| date | date | Note date |
| type | string | Note type; one of values: note, deal |
| deal | hash | (Only for deals) Deal specific data. This element will be described in the table below |
| contact | hash | (Only when note data is returned by sales methods) Contact specific data. This element will be described in the table below. |
| Name | Type | Description |
| amount | float | Deal amount |
| status | string | Deal status; one of the values: pending, lost, won |
| closed | date | Deal close date; nil if it’s pending deal; this value is read-only and it’s set to the current time when won/lost deal is created/updated from pending deal |
| deal_stage | integer | Pending deal stage value (10 for 10%, 25 for 25% etc.). This element is used only for pending deals and only when pipeline mode is set to full. In all other cases should be ignored. |
| exp_close | date | Pending deal expected close date. This element is used only for pending deals and only if pipeline mode is not set to off. It should be ignored when pipeline mode is set to off. |
| Name | Type | Description |
| firstname | string | Contact firstname |
| lastname | string | Contact lastname |
| company | string | Company name |
Sample JSON server response for getting list of contact notes
