# Get Opportunity Note List

## Get Opportunity Note List

<mark style="color:green;">`POST`</mark> `[PlatformAddress]/api/1.0/crm?action=getOpportunityNoteList`

Fetches a list of notes for a specific opportunity.

#### Path Parameters

| Name    | Type    | Description                                                                                                       |
| ------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
| leadId  | integer | The unique identifier of the opportunity to which the opportunity notes belong                                    |
| venueId | integer | The unique identifier of the venue to which the opportunity notes belong                                          |
| perPage | integer | The number of opportunity notes to fetch                                                                          |
| start   | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) |

{% tabs %}
{% tab title="200 " %}

```
{
    "meta": {
        "totalResults": 10,
        "start": 0,
        "perPage": 50,
        "count": 3
    },
    "results": [
        {
            "id": 2,
            "leadId": 4,
            "note": "<p>Opportunity Note 1</p>\n",
            "createdByUserId": 1,
            "createdDate": "2022-06-12 06:06:03 UTC",
            "modifiedDate": "2022-07-13 01:32:10"
        },
        {
            "id": 4,
            "leadId": 4,
            "note": "Opportunity Note 2",
            "createdByUserId": 1,
            "createdDate": "2022-07-13 01:27:27 UTC",
            "modifiedDate": "2022-07-13 01:27:27"
        },
        {
            "id": 5,
            "leadId": 4,
            "note": "Opportunity Note 3",
            "createdByUserId": 1,
            "createdDate": "2022-07-13 01:29:41 UTC",
            "modifiedDate": "2022-07-13 01:29:41"
        },
    ]
}

```

{% endtab %}
{% endtabs %}

The result from this call will be a [collection](https://developer.ivvy.com/getting-started/interpreting-the-response/collections) of opportunity note to which the user has access. This call also accepts the [pagination](https://developer.ivvy.com/getting-started/interpreting-the-response/pagination) and [filter](https://developer.ivvy.com/getting-started/interpreting-the-response/filtering) properties.

## Example Request

`Fetches a list of Notes for a specific Opportunity`

```javascript
{
    "venueId": 1
    "leadId" : 4,
    "perPage" : 50
}
```

## Opportunity Note

| Property        | Type      | Description                                            |
| --------------- | --------- | ------------------------------------------------------ |
| id              | integer   | The unique id of the opportunity note                  |
| leadId          | integer   | The opportunity to which the opportunity note belongs  |
| note            | string    | The opportunity note                                   |
| createdByUserId | integer   | The details of person who created the opportunity note |
| createdDate     | timestamp | The date & time the opportunity note was created       |
| modifiedDate    | timestamp | The date & time the opportunity note was last modified |