> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slant.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List notes

> List all notes for a household



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/households/{household_id}/notes
openapi: 3.0.1
info:
  title: Slant Public API V1
  version: v1
  description: Public API for creating and managing resources in Slant
  contact:
    name: Slant API Support
    email: api@slant.com
servers:
  - url: https://api.slant.app
security:
  - bearer: []
paths:
  /v1/households/{household_id}/notes:
    parameters:
      - name: household_id
        in: path
        description: The household ID
        required: true
        example: household123xyz
        schema:
          type: string
    get:
      tags:
        - Notes
      summary: List notes
      description: List all notes for a household
      parameters:
        - name: page
          in: query
          schema:
            type: integer
          description: Page number
          required: false
          example: 1
        - name: per_page
          in: query
          description: >-
            Items per page (1-100, default: 25). Values over 100 will be clamped
            to 100.
          required: false
          example: 25
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: hidden
          in: query
          description: Filter by hidden status
          required: false
          schema:
            type: boolean
        - name: pinned
          in: query
          description: Filter by pinned status
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - content
                        - pinned
                        - tag_ids
                        - references
                        - book_id
                        - created_at
                        - updated_at
                      properties:
                        id:
                          type: string
                          description: The note ID
                          example: abc123xyz
                        content:
                          type: string
                          description: The plaintext content of the note
                          example: Meeting notes from client discussion
                        pinned:
                          type: boolean
                          description: Whether the note is pinned
                          example: false
                        hidden:
                          type: boolean
                          description: Whether the note is hidden
                          example: false
                        tag_ids:
                          type: array
                          description: The complete set of label IDs applied to the note
                          items:
                            type: string
                        references:
                          type: array
                          description: Records referenced by the note
                          items:
                            type: object
                            required:
                              - id
                              - type
                              - label
                            properties:
                              id:
                                type: string
                                description: The referenced record ID
                              type:
                                type: string
                                enum:
                                  - Business
                                  - Client
                                  - Contact
                                  - Household
                                  - Person
                                  - Prospect
                                  - Trust
                                  - User
                                description: The referenced record type
                              label:
                                type: string
                                description: The server-derived display label
                        book_id:
                          type: string
                          description: The book ID
                          example: book123xyz
                        household_id:
                          type: string
                          description: The household ID
                          example: household123xyz
                          nullable: true
                        created_by_id:
                          type: string
                          description: The ID of the user who created the note
                          example: user123xyz
                          nullable: true
                        created_at:
                          type: string
                          format: date-time
                          description: When the note was created
                        updated_at:
                          type: string
                          format: date-time
                          description: When the note was last updated
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 10
                      total_count:
                        type: integer
                        example: 100
                      per_page:
                        type: integer
                        example: 25
        '400':
          description: bad request - invalid JSON
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - invalid_json
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '401':
          description: unauthorized - missing or invalid token
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - token_missing
                      - token_invalid
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '403':
          description: forbidden
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth 2.0 Bearer Token from Clerk authentication

````