VUZDevelopers

List notes with filtering and pagination

GET
/crm/notes

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

clientId?string

Filter by client UUID

dealId?string

Filter by deal UUID

isPinned?boolean

Filter pinned notes only

page?number

Page number (starting from 1)

Range1 <= value
Default1
limit?number

Number of items per page (max 100)

Range1 <= value <= 100
Default10

Response Body

application/json

curl -X GET "https://example.com/crm/notes"
{  "items": [    {      "id": "string",      "businessId": "string",      "content": "string",      "title": "string",      "contentFormat": "string",      "isPinned": true,      "clientId": "string",      "dealId": "string",      "meetingId": "string",      "authorUserId": "string",      "authorUserName": "string",      "attachments": [        {          "id": "string",          "filename": "string",          "url": "string",          "mimeType": "string",          "fileSize": 0        }      ],      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "page": 0,  "limit": 0}