CMS Tool API

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

NameTypeExampleNotes
idint123Filter results by id.
mbr_idint123Filter results by mbr id.
from_uidint123Filter results by from uid.
note_subjecttextexampleFilter results by note subject.
note_typetextexampleFilter results by note type.
offsetint123Skip this many matching records before returning results.
pageSizeint123Limit the number of records returned.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

NameTypeExampleNotes
idint123Set the id value.
mbr_idint123Set the mbr id value.
note_subjecttextexampleSet the note subject value.
note_bodytextexampleSet the note body value.
note_typetextexampleSet 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.