Get all notes

GET /api/v1/note/{notableType}/{notableUuid}

Path parameters

  • notableType integer Required
  • notableUuid string Required
  • notable_type string Required

    The type of model to look for. Make sure it is a valid model type that can have notes. Valid types are: ['account', 'board_task', 'case', 'conversation', 'illustration'] .

  • notable_uuid string Required

    The UUID of the notable model.

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [tags, mentionedAccounts].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[type] string

    Note type to filter by. Valid types are [call, note, meeting, email]

  • filter[date_from] string

    Note created_at date to filter from a specific date, can be used with date_to for a range.

  • filter[date_to] string

    Note created_at date to filter to from a specific date, can be used with date_from for a range.

  • filter[contents] string

    Filter notes by a string to see if it's contents contains that string.

  • filter[path] string

    Filter notes by a string to see if the path contains that string.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, type]. Negative sign to denote DESC. Defaults to 'created_at'.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/note/{notableType}/{notableUuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/note/notableType/notableUuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "tags": [
        {
          "name": "Mortgage",
          "slug": "mortgage",
          "uuid": "cce960d0-a238-4a61-b547-9acef389468e",
          "colour": "#ef4582",
          "created_at": "2024-10-16T11:10:15+01:00",
          "updated_at": "2024-10-16T11:10:15+01:00"
        }
      ],
      "type": "meeting",
      "uuid": "16ffddcf-86ba-4db9-92e0-e458a603030a",
      "edited": true,
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "f94d407e-d050-4a5a-8260-080582ee7f7a",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:15+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:15+01:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-10-16T11:10:15+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:15+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:15+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:15+01:00"
      },
      "notable": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "cf92f314-4094-427f-ab38-05bf6ec984bf",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:15+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:15+01:00",
        "with_login": true,
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2024-10-16T11:10:15+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:15+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:15+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:15+01:00"
      },
      "contents": "Great work",
      "created_at": "2024-10-16T11:10:15+01:00",
      "updated_at": "2024-10-16T11:10:15+01:00",
      "notable_type": "client",
      "mentioned_accounts": [
        {
          "item": "Gareth Thompson",
          "contents": "<span data-type=\"mention\" data-account-uuid=\"3bc3c192-aaa5-4766-b8ba-234c20c8ff38\">@Gareth Thompson</span>"
        }
      ]
    }
  ]
}