TasksV3

Get all tasks

Beta
GET
https://api.joincandidhealth.com/api/tasks/v3

Query parameters

limit
optional integer
Defaults to 100
page_token
optional string
status
optional enum
task_type
optional enum
categories
optional string
Only return tasks with categories that match one in this comma-separated list.
updated_since
optional datetime
Only return tasks updated on or after this date-time
encounter_id
optional UUID
Only return tasks associated with this encounter
search_term
optional string
Query tasks by encounter_id, claim_id, task_id, or external_id
assigned_to_id
optional UUID
Only return tasks assigned to this user
date_of_service_min
optional date
The minimum date of service for the linked encounter
date_of_service_max
optional date
The maximum date of service for the linked encounter
billing_provider_npi
optional string
The NPI of the billing provider associated with the task's claim
sort
optional enum
Defaults to updated_at:desc

Response

This endpoint return an object.
items
list of objects
next_page_token
optional string
prev_page_token
optional string

Errors

GET
/api/tasks/v3
curl -G https://api.joincandidhealth.com/api/tasks/v3 \
-H "Authorization: Bearer <token>" \
-d limit=0 \
-d page_token=string
Response
{
"items": [
{
"task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"task_type": "CUSTOMER_DATA_REQUEST",
"description": "string",
"blocks_claim_submission": true,
"external_id": "string",
"patient_name": "string",
"patient_external_id": "string",
"status": "finished",
"notes": [
{
"task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"text": "string",
"created_at": "2023-01-01T00:00:00Z",
"author_name": "string",
"author_organization_name": "string"
}
],
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z",
"agg_updated_at": "2023-01-01T00:00:00Z",
"date_of_service": "2023-01-01",
"assignments": [
{
"task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
}
],
"payer_name": "string",
"payer_id": "string",
"category": "other"
}
],
"next_page_token": "string",
"prev_page_token": "string"
}