Get all tasks — Candid

Query parameters

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

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

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 "payer_name": "string", 13 "payer_id": "string", 14 "status": "finished", 15 "notes": [ 16 { 17 "task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 18 "text": "string", 19 "created_at": "2023-01-01T00:00:00Z", 20 "author_name": "string", 21 "author_organization_name": "string" 22 } 23 ], 24 "created_at": "2023-01-01T00:00:00Z", 25 "updated_at": "2023-01-01T00:00:00Z", 26 "agg_updated_at": "2023-01-01T00:00:00Z", 27 "date_of_service": "2023-01-01", 28 "assignments": [ 29 { 30 "task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", 31 "assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" 32 } 33 ], 34 "category": "other" 35 } 36 ], 37 "prev_page_token": "string", 38 "next_page_token": "string" 39 }

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	"payer_name": "string",
13	"payer_id": "string",
14	"status": "finished",
15	"notes": [
16	{
17	"task_note_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18	"text": "string",
19	"created_at": "2023-01-01T00:00:00Z",
20	"author_name": "string",
21	"author_organization_name": "string"
22	}
23	],
24	"created_at": "2023-01-01T00:00:00Z",
25	"updated_at": "2023-01-01T00:00:00Z",
26	"agg_updated_at": "2023-01-01T00:00:00Z",
27	"date_of_service": "2023-01-01",
28	"assignments": [
29	{
30	"task_assignment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
31	"assignee_user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
32	}
33	],
34	"category": "other"
35	}
36	],
37	"prev_page_token": "string",
38	"next_page_token": "string"
39	}