Get task

Beta

GET

Path parameters

task_idUUIDRequired

Response

This endpoint returns an object.

task_idUUID

encounter_idUUID

task_typeenum

descriptionstring

blocks_claim_submissionboolean

external_idstring

patient_namestring

patient_external_idstring

statusenum

noteslist of objects

created_atdatetime

updated_atdatetime

The time of most recent update to the task only

agg_updated_atdatetime

The time of most recent update to the task or any of its notes

date_of_servicedate

assignmentslist of objects

payer_namestringOptional

payer_idstringOptional

categoryenumOptional

Errors

GET

1 curl https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

1 {
2   "task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4   "task_type": "CUSTOMER_DATA_REQUEST",
5   "description": "string",
6   "blocks_claim_submission": true,
7   "external_id": "string",
8   "patient_name": "string",
9   "patient_external_id": "string",
10   "payer_name": "string",
11   "payer_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   "category": "other"
33 }

Built with

1	curl https://api.joincandidhealth.com/api/tasks/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2	-H "Authorization: Bearer <token>"

1	{
2	"task_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3	"encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4	"task_type": "CUSTOMER_DATA_REQUEST",
5	"description": "string",
6	"blocks_claim_submission": true,
7	"external_id": "string",
8	"patient_name": "string",
9	"patient_external_id": "string",
10	"payer_name": "string",
11	"payer_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	"category": "other"
33	}