notes.get
One note you may see, with every earlier wording (history, oldest first).
When to use it
One note you may see, with every earlier wording (history, oldest first).
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
note_id | string (uuid) | yes |
Example
GET https://doingwork.work/v1/notes/get?note_id=00000000-0000-4000-8000-000000000000
Output
| Field | Type | Always there |
|---|
note_id | string (uuid) | yes |
shop_id | string (uuid) | yes |
target_kind | string | yes |
target_id | string (uuid) | yes |
job_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
visit_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
mentions | array | yes |
agent_name | ['string', 'null'] | yes |
source | string | yes |
channel | ['string', 'null'] | yes |
body | string | yes |
audience | string | yes |
pinned | boolean | yes |
media_ids | array | yes |
recorded_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
duration_seconds | ['integer', 'null'] | yes |
transcribed_with | ['string', 'null'] | yes |
language | ['string', 'null'] | yes |
revisions | integer | yes |
written_by | string (uuid) | yes |
written_by_name | ['string', 'null'] | yes |
created_at | string (date-time) | yes |
edited_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
removed_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
removed_by | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
remove_reason | ['string', 'null'] | yes |
history | array | yes |
history[].body | string | yes |
history[].until | string (date-time) | yes |
{
"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": "...",
"history": [
{
"body": "...",
"until": "..."
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |