SLslant
Notes

List notes

Changed on

List all notes for a household

get/v1/households/{household_id}/notes

Request

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

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

hiddenboolean

Filter by hidden status

pinnedboolean

Filter by pinned status

Response

successful

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "content": "Meeting notes from client discussion",
      "book_id": "book123xyz",
      "household_id": "household123xyz",
      "created_by_id": "user123xyz"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}

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