Notes

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
chevron-right
200Success
application/json
get
/api/users/notes
200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
commentsstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
titlestring · max: 250Optional
bodystringRequired
colorstring · max: 50 · nullableOptional
mediaanyOptional
sermonstring · uuid · nullableOptional
childstring · uuid · nullableOptional
Responses
post
/api/users/notes
201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this note.

Responses
chevron-right
200Success
application/json
get
/api/users/notes/{id}
200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this note.

Body
idstring · uuidRead-onlyRequired
commentsstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
titlestring · max: 250Optional
bodystringRequired
colorstring · max: 50 · nullableOptional
mediaanyOptional
sermonstring · uuid · nullableOptional
childstring · uuid · nullableOptional
Responses
chevron-right
200Success
application/json
put
/api/users/notes/{id}
200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this note.

Responses
delete
/api/users/notes/{id}
204

No response body

No content

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

A UUID string identifying this note.

Body
idstring · uuidRead-onlyOptional
commentsstringRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
titlestring · max: 250Optional
bodystringOptional
colorstring · max: 50 · nullableOptional
mediaanyOptional
sermonstring · uuid · nullableOptional
childstring · uuid · nullableOptional
Responses
chevron-right
200Success
application/json
patch
/api/users/notes/{id}
200Success