Notes

View all notes

Fetch a list of notes

GET https://web.r0app.com/api/v1/orgs/:org_id/notes

Returns a paginated list of notes in your account.

Query Parameters

Name	Type	Description
page	Integer	For more info, see the pagination section in the Getting started guide.
limit	Integer	For more info, see the pagination section in the Getting started guide.
include[]	String	If set to deleted all active and deleted records will be returned in the response.
include[]	String	If set to tags the first few tags associated with a note will be included in the response.
include[]	String	If set to contacts the first few contacts associated with a note will be included in the response.

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/notes \
    -X GET \
    -H 'Authorization: Bearer <token>'

View a note

Fetch a note

GET https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id

Returns a single note given an id in the path.

Path Parameters

Name	Type	Description
:note_id*	UUID

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id \
    -X GET \
    -H 'Authorization: Bearer <token>'

Upload a note

Upload a note

POST https://web.r0app.com/api/v1/orgs/:org_id/notes

Request Body

Name	Type	Description
note[note]*	String
note[personal_note]	Boolean	If true no one else in your account can view the note.
tags[]	UUID
contacts[]	UUID

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/notes \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F 'note[note]=This is an example.' \
    -F 'contacts[]=b0063875-54e1-45e4-94de-72545fdc88a7'

Update a note

Update a note

PATCH https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id

Path Parameters

Name	Type	Description
:note_id*	UUID

Request Body

Name	Type	Description
note[note]	String
personal_note	String	If true no one else in your account can view the note.
tags[]	UUID
contacts[]	UUID

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -F 'note[note]=This is an example.'

Request body details:

{
  "note": {
    "note": "lorem ipsum",
    "personal_note": true
  },
  "tags": ["94cf6f37-307e-41d4-adcf-802eea9823f8"],
  "contacts": []
}

Delete a note

Delete a note

DELETE https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id

Path Parameters

Name	Type	Description
:note_id*	UUID

Example request

curl

curl https://web.r0app.com/api/v1/orgs/:org_id/notes/:note_id \
    -X DELETE \
    -H 'Authorization: Bearer <token>'