Before You Start: Lookups
What you need | Endpoint | Example |
Users (assignees) |
|
|
Teams (assignees) |
|
|
Task categories |
|
|
GET /v1/tasks/categories
{
"Items": [
{ "Id": "TC7ec7f010ce4b621b83743f8297c00da9", "Name": "QC Needed", "Archived": false },
{ "Id": "TC15d53f005f3b2fda94c486fbd959c6ba", "Name": "New Insurance Required", "Archived": false }
]
}
Create a Task
POST /v1/tasks
Fields
Field | Required | Notes |
| ✅ |
|
| ✅ | One or more assignees: |
|
|
|
|
|
|
|
|
|
|
| From |
|
| Related patient IDs |
|
| Related order IDs |
|
| Related invoice IDs |
|
| Related patient documents: |
Documents[].Type is deprecated; send only Id.
Example
POST /v1/tasks
{
"Title": "Verify new insurance",
"Description": "Patient reported a new primary insurance. Verify eligibility and update the record.",
"Priority": "High",
"DueDate": "2026-11-12",
"CategoryId": "TC15d53f005f3b2fda94c486fbd959c6ba",
"AssignTo": [
{ "Id": "91", "Type": "User" }
],
"Patients": ["10000105"],
"Orders": ["SO05adce00ef4b092b90f42f97b2ec3e36"]
}
Response: 201 Created
{ "Id": "TKc5ec2c002dea588b9e841be48513a191" }
Search Tasks
GET /v1/tasks
Filter | Notes |
|
|
|
|
|
|
| Tasks related to these records |
|
|
|
|
|
|
| Paging |
{
"Items": [
{
"Id": "TKc5ec2c002dea588b9e841be48513a191",
"DisplayId": "TK-8513A191",
"Title": "Call back - update profile",
"Status": "Open",
"Priority": "Normal",
"AssignTo": [{ "Id": "91", "Name": "Jane Smith", "Type": "User" }],
"Patients": ["10000003"],
"Orders": [],
"Invoices": [],
"Documents": [],
"CreatedOn": "2026-11-10T15:49:16+00:00"
}
]
}
Get one task: GET /v1/tasks/{id}
Update a Task
PUT /v1/tasks/{id}
Send the full task, using the same fields as creating one. Title and AssignTo are required.
Response: 200 OK
Complete Tasks
POST /v1/tasks/complete
{ "Ids": ["TKc5ec2c002dea588b9e841be48513a191"] }
Response: 200 OK
Delete Tasks
DELETE /v1/tasks
This endpoint takes a request body with the task IDs.
{ "Ids": ["TKc5ec2c002dea588b9e841be48513a191"] }
Response: 200 OK
Task Notes
Endpoint | Purpose |
| Add a note |
| List notes (filters: |
| Get one note |
POST /v1/tasks/TKc5ec2c002dea588b9e841be48513a191/notes
{
"Text": "Left voicemail for patient.",
"AddPatientNote": true
}
💡 Set AddPatientNote to true to also add the note to the related patient's notes.
Response: 201 Created, which returns the note Id.
Task Documents
Download a document attached to a task:
GET /v1/tasks/{id}/documents/{documentId}/download
Get Notified of Changes
Subscribe to task.created, task.updated, task.deleted, and task.note.created.
See Webhooks API.
Common Errors
Code | Meaning |
| Invalid request, e.g. a missing |
| Token missing, expired, or invalid |
| You don't have permission to access this resource |
| Task, note, or related record not found |
| Too many requests |
