Beta

Get task

GET

/api/tasks/v3/:task_id

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.tasks.v_3.get(
10     task_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Play

200Retrieved

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

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

Get task

Path parameters

Headers

Response

Errors