List notes
Paginated deal notes. Optional `deals_id` filter. `search` matches description.
get
/api/v1/notes
Security
Parameters
| Name | In | Type | Details | |
|---|---|---|---|---|
page |
query |
integer
|
optional |
Default:
1 |
per_page |
query |
integer
|
optional |
Items per page (1–100, default 15) Default:
15 |
search |
query |
string
|
optional | Search across entity fields and nested CRM emails/phones/addresses |
deals_id |
query |
integer
|
optional | Filter by deal id |
Responses
200
Paginated notes
application/json
{
"allOf": [
{
"title": "API envelope",
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"errors": {
"nullable": true
},
"meta": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Note",
"type": "object",
"required": [
"id",
"description",
"is_pinned"
],
"properties": {
"id": {
"type": "integer"
},
"description": {
"type": "string"
},
"deals_id": {
"type": "integer",
"nullable": true
},
"is_pinned": {
"type": "boolean"
},
"created_by": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"title": "Pagination",
"type": "object",
"properties": {
"current_page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"last_page": {
"type": "integer"
},
"from": {
"type": "integer",
"nullable": true
},
"to": {
"type": "integer",
"nullable": true
}
}
}
}
}
}
}
]
}
401
Missing or invalid API key
application/json
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string",
"example": "Missing API key (X-Api-Key)"
}
}
}