notes.list

Notes you may see on one record (target_kind and target_id), on a job (job_id: the job, its visits and anything on it such as its photos, quotes and invoices), on one visit, or the notes that mention you (mentioning_me). Pinned first, then newest first. Filter by source (typed or voice_memo); removed notes are left out unless include_removed is true. Read the notes on a record before you work on it.

WhoAgents can call this
RESTGET /v1/notes
MCP toolnotes_list
Writesno
AreaField work (checklists, forms, time, notes, change orders, subcontractors)

When to use it

Notes you may see on one record (target_kind and target_id), on a job (job_id: the job, its visits and anything on it such as its photos, quotes and invoices), on one visit, or the notes that mention you (mentioning_me). Pinned first, then newest first.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
target_kindstring (one of job, visit, media, customer, property, equipment, quote, invoice, request, worker, payment, pricebook_item, maintenance_plan, shop)no
target_idstring (uuid)no
job_idstring (uuid)no
visit_idstring (uuid)no
mentioning_mestring (one of true, false)no
sourcestring (one of typed, voice_memo)no
include_removedstring (one of true, false)no

Example

GET https://doingwork.work/v1/notes?target_kind=job&target_id=00000000-0000-4000-8000-000000000000&job_id=00000000-0000-4000-8000-000000000000&visit_id=00000000-0000-4000-8000-000000000000&mentioning_me=true&source=typed&include_removed=true

Output

FieldTypeAlways there
itemsarrayyes
items[].note_idstring (uuid)yes
items[].shop_idstring (uuid)yes
items[].target_kindstringyes
items[].target_idstring (uuid)yes
items[].job_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].visit_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].mentionsarrayyes
items[].agent_name['string', 'null']yes
items[].sourcestringyes
items[].channel['string', 'null']yes
items[].bodystringyes
items[].audiencestringyes
items[].pinnedbooleanyes
items[].media_idsarrayyes
items[].recorded_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].duration_seconds['integer', 'null']yes
items[].transcribed_with['string', 'null']yes
items[].language['string', 'null']yes
items[].revisionsintegeryes
items[].written_bystring (uuid)yes
items[].written_by_name['string', 'null']yes
items[].created_atstring (date-time)yes
items[].edited_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].removed_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].removed_by['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].remove_reason['string', 'null']yes
{
  "items": [
    {
      "note_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "target_kind": "...",
      "target_id": "00000000-0000-4000-8000-000000000000",
      "job_id": "00000000-0000-4000-8000-000000000000",
      "visit_id": "00000000-0000-4000-8000-000000000000",
      "mentions": [
        "00000000-0000-4000-8000-000000000000"
      ],
      "agent_name": "...",
      "source": "...",
      "channel": "...",
      "body": "...",
      "audience": "...",
      "pinned": true,
      "media_ids": [
        "00000000-0000-4000-8000-000000000000"
      ],
      "recorded_at": "...",
      "duration_seconds": "...",
      "transcribed_with": "...",
      "language": "...",
      "revisions": 1,
      "written_by": "00000000-0000-4000-8000-000000000000",
      "written_by_name": "...",
      "created_at": "...",
      "edited_at": "...",
      "removed_at": "...",
      "removed_by": "00000000-0000-4000-8000-000000000000",
      "remove_reason": "..."
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.