Notes

Notes belongs to a Contact or Property.

Object Definition

Field	Type	Description
uuid	string	Unique identifier for the object
created_at	string	ISO 8601 datetime when the note was originally created
updated_at	string	ISO 8601 datetime when the note was last updated
content	string	Content of the note

List all Notes

Retrieve a paginated list of all the accounts Notes. GET /notes.

Filters

You may filter the results from the list endpoint using the following query parameters

Field	Type	Description
contact	Relational Filter	Filter using contact attributes
property	Relational Filter	Filter using property attributes

Example Response

{
  "data": [
    {
      "uuid": "bed5faf6-3618-4291-942e-64a1e5786343",
      "created_at": "2018-08-02T15:15:55+01:00",
      "updated_at": "2018-08-02T15:15:58+01:00",
      "content": "Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit."
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

Get a single Note

Retrieve a single note by it's uuid. GET /notes/:uuid.

Example Response

{
  "data": {
    "uuid": "bed5faf6-3618-4291-942e-64a1e5786343",
    "created_at": "2018-08-02T15:15:55+01:00",
    "updated_at": "2018-08-02T15:15:58+01:00",
    "content": "Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit."
  }
}

Creating a Note

There are two endpoints for creating a note, depending if you want to associate it with a Contact or Property. Perform a POST request to any of the following endpoints, they return a HTTP 201 status code on success.

• /properties/:uuid/notes
• /contacts/:uuid/notes

Input

Field	Type	Description
content	string	Content of the note Required

Updating a Note

You cannot update a note at this time

Deleting a Note

Perform a DELETE request to the /notes/:uuid endpoint. This endpoint will return a HTTP 204 status code on success.