Return a list of forms this user can access

GET /notes/list/{uniqueid}
Oauth security

A full list of notes for the requested user Additional optional path parameters /{page} : The page number to show, integer /{searchby}: How to search. notetypeid: Filter by note type ID /{searchvalue}: The value to search by When search by is notetypeid then value is the ID

Path parameters

  • uniqueid integer Required

    The ID of the user. The logged in user needs to be able to have access to this user.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • items object
      Hide items attributes Show items attributes
      • note_id integer

        The unique ID for this specific note

      • for object
        Hide for attributes Show for attributes
        • code string

          Which entity this id is applicable for P: Person, the individual H: Household, the household this person is connected to

          Values are P or H.

        • text string

          The decode of the code

          Values are Person or Household.

      • date_saved string

        The UTC Date this note eas saved

      • date_saved_show string

        The date shown in the format set in administration - system

      • text string

        The text of the note

      • visible_to object
        Hide visible_to attributes Show visible_to attributes
        • type string

          Which configuration of users is allowed to see this note. me: Just the person who created the note group: A group, this will be populated in the group_id and group_name parameters anyone: Anyone who has access to this user and notes

        • group_id integer

          The id of the group that members has permission to see this note

        • group_name string

          The decode of the group_id

      • created_by object
        Hide created_by attributes Show created_by attributes
      • note_type object

        The note type this note is tagged with

        Hide note_type attributes Show note_type attributes
      • color_code object
        Hide color_code attributes Show color_code attributes
        • code string

          The color code used for this note

          Values are transparent, 929497, 9a75ab, f3b24d, f5324e, 39c3d1, 82ca68, f278a9, or 45bdb3.

        • name string

          The decode (key) value of this color code

      • permissions object
        Hide permissions attributes Show permissions attributes
        • edit string

          Whether the logged in user can edit this note

          Values are Y or N.

        • delete string

          Whether the logged in user can delete this note

          Values are Y or N.

    • paging object
      Hide paging attributes Show paging attributes
GET /notes/list/{uniqueid} 
curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/notes/list/{uniqueid} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "items": {
    "note_id": 8841,
    "for": {
      "code": "P",
      "text": "Person"
    },
    "date_saved": "2022-03-29 13:13:27",
    "date_saved_show": "29 Mar 2022 13:13",
    "text": "This person is enjoying working with us.",
    "visible_to": {
      "type": "me",
      "group_id": 530,
      "group_name": "Staff Group"
    },
    "created_by": {
      "unique_id": 2137,
      "name": "Mr John Smith"
    },
    "note_type": {
      "name": "Staff Visits",
      "id": 113
    },
    "color_code": {
      "code": "transparent",
      "name": "General"
    },
    "permissions": {
      "edit": "Y",
      "delete": "Y"
    }
  },
  "paging": {
    "total": 5,
    "pages": 1,
    "thispage": 1,
    "firstpage": 1,
    "initialpage": "string",
    "finalpage": "string",
    "lastpage": 1,
    "shown_on_this_page": 5
  }
}