SLslant
Notes

Get a note

Changed on

Retrieve a note by ID

get/v1/households/{household_id}/notes/{id}

Request

  • Base URL
    https://api.slant.app
  • URL
    https://api.slant.app/v1/households/{household_id}/notes/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The note ID

Response

successful

idstring required

The note ID

contentstring required

The plaintext content of the note

pinnedboolean required

Whether the note is pinned

hiddenboolean

Whether the note is hidden

tag_idsstring[] required

The complete set of label IDs applied to the note

book_idstring required

The book ID

household_idstring nullable

The household ID

notable_typestring required

The type of record the note belongs to

notable_idstring required

The ID of the record the note belongs to

created_by_idstring nullable

The ID of the user who created the note

created_atstring date-time required

When the note was created

updated_atstring date-time required

When the note was last updated

Example response

{
  "id": "abc123xyz",
  "content": "Meeting notes from client discussion",
  "book_id": "book123xyz",
  "household_id": "household123xyz",
  "created_by_id": "user123xyz"
}

Changes

  • 173c41bf6be9Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      removed the invalid_json enum value from the response property for the response status

    • info

      response property detail list-of-types was narrowed by removing types array from media type application/json of response 400

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status