FluentCRM Developers

Appearance

View as Markdown

GET Get Company Notes​

GET
/companies/{id}/notes

Retrieve a paginated list of notes for a company. Notes are ordered by ID descending (newest first). Each note includes the added_by field showing who created it. Also returns note sync fields configuration.

Required capability: fcrm_manage_contact_cats

Enforced by CompanyPolicy::verifyRequest(), the policy default for this route group.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The company ID.

Type
integer
Required

Query Parameters

search

Search notes by title (LIKE match).

Type
string
per_page

Number of notes per page.

Type
integer
Default
15
page

Page number for pagination.

Type
integer
Default
1
include_id

Id of a note that must appear in the response even when it falls outside the current page. When it is not already on the page it is returned separately as included_note, scoped to this company.

Type
integer

Responses​

Paginated list of company notes.

application/json
JSON
{
"notes": {
"total": 0,
"per_page": 0,
"current_page": 0,
"last_page": 0,
"next_page_url": "string",
"prev_page_url": "string",
"from": 0,
"to": 0,
"data": [
{
"id": 0,
"subscriber_id": 0,
"title": "string",
"description": "string",
"type": "string",
"created_at": "string",
"updated_at": "string",
"added_by": "string"
}
]
},
"fields": {
"fields": [
{
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI