CMS Tool API schema
Public API version 1.4.10.
/api/membernotes
Read and update notes about members.
GET
List records, or retrieve one by appending its ID to the path.
Query parameters
| Name | Type | Example | Notes |
|---|---|---|---|
id | int | 123 | Filter results by id. |
mbr_id | int | 123 | Filter results by mbr id. |
from_uid | int | 123 | Filter results by from uid. |
note_subject | text | example | Filter results by note subject. |
note_type | text | example | Filter results by note type. |
offset | int | 123 | Skip this many matching records before returning results. |
pageSize | int | 123 | Limit the number of records returned. |
POST
Create or update a record from a JSON object.
Request content type: application/json
Request body fields
| Name | Type | Example | Notes |
|---|---|---|---|
id | int | 123 | Set the id value. |
mbr_id | int | 123 | Set the mbr id value. |
note_subject | text | example | Set the note subject value. |
note_body | text | example | Set the note body value. |
note_type | text | example | Set the note type value. |
Machine-readable documentation
This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.