Get all tasks

limitintegerOptional

Defaults to 100

page_tokenstringOptional

statusenumOptional

task_typeenumOptional

categoriesstringOptional

Only return tasks with categories that match one in this comma-separated list.

updated_sincedatetimeOptional

Only return tasks updated on or after this date-time

encounter_idUUIDOptional

Only return tasks associated with this encounter

search_termstringOptional

Query tasks by encounter_id, claim_id, task_id, or external_id

assigned_to_idUUIDOptional

Only return tasks assigned to this user

date_of_service_mindateOptional

The minimum date of service for the linked encounter

date_of_service_maxdateOptional

The maximum date of service for the linked encounter

billing_provider_npistringOptional

The NPI of the billing provider associated with the task's claim

sortenumOptional

Defaults to updated_at:desc

1 curl -G https://api.joincandidhealth.com/api/tasks/v3 \ 2 -H "Authorization: Bearer <token>" \ 3 -d limit=0 \ 4 -d page_token=string

1 { 2 "items": [ 3 { 4 "task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 5 "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 6 "task_type": "CUSTOMER_DATA_REQUEST", 7 "description": "string", 8 "blocks_claim_submission": true, 9 "external_id": "string", 10 "patient_name": "string", 11 "patient_external_id": "string", 12 "status": "finished", 13 "notes": [ 14 { 15 "task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 16 "text": "string", 17 "created_at": "2023-01-01T00:00:00Z", 18 "author_name": "string", 19 "author_organization_name": "string" 20 } 21 ], 22 "created_at": "2023-01-01T00:00:00Z", 23 "updated_at": "2023-01-01T00:00:00Z", 24 "agg_updated_at": "2023-01-01T00:00:00Z", 25 "date_of_service": "2023-01-01", 26 "assignments": [ 27 { 28 "task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 29 "assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 30 } 31 ], 32 "payer_name": "string", 33 "payer_id": "string", 34 "category": "other" 35 } 36 ], 37 "next_page_token": "string", 38 "prev_page_token": "string" 39 }

Query parameters

Response

Errors

1	curl -G https://api.joincandidhealth.com/api/tasks/v3 \
2	-H "Authorization: Bearer <token>" \
3	-d limit=0 \
4	-d page_token=string

1	{
2	"items": [
3	{
4	"task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6	"task_type": "CUSTOMER_DATA_REQUEST",
7	"description": "string",
8	"blocks_claim_submission": true,
9	"external_id": "string",
10	"patient_name": "string",
11	"patient_external_id": "string",
12	"status": "finished",
13	"notes": [
14	{
15	"task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16	"text": "string",
17	"created_at": "2023-01-01T00:00:00Z",
18	"author_name": "string",
19	"author_organization_name": "string"
20	}
21	],
22	"created_at": "2023-01-01T00:00:00Z",
23	"updated_at": "2023-01-01T00:00:00Z",
24	"agg_updated_at": "2023-01-01T00:00:00Z",
25	"date_of_service": "2023-01-01",
26	"assignments": [
27	{
28	"task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
29	"assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
30	}
31	],
32	"payer_name": "string",
33	"payer_id": "string",
34	"category": "other"
35	}
36	],
37	"next_page_token": "string",
38	"prev_page_token": "string"
39	}