Skip to content
API reference/
API Reference
/
/
Get Task

Get Task
deprecated

Request

Retrieve task information for the given ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/tasks/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
type_labelstringrequired
statusstringrequired
Enum:"open""closed""in_progress"
detailsstring or null
categorystringrequired
patientobjectrequired
form_responseobject
appointmentobject
communicationobject
noteobject
assignee_idstring or null
assignee_typestring
assignee_namestring or null
prioritystringrequired
Enum:"lowest""low""medium""high""highest"
created_atstringrequired
titlestringrequired
title_sub_textstringrequired
namestringrequired
taskable_typestringrequired
triggered_byobject or null
system_alert_detailsobject or null
form_response_idstring or number or null
One of:
string
communication_idstring or number or null
One of:
string
appointment_idstring or number or null
One of:
string
note_idstring or number or null
One of:
string
Response
{
  "id": "string",
  "type_label": "string",
  "status": "open",
  "details": "string",
  "category": "string",
  "patient": {
    "id": "string",
    "uid": "string",
    "ehr_partner_id": "string",
    "emis_id": "string",
    "deceased_at": "2019-08-24T14:15:22Z",
    "ods_code": "string",
    "dob": "2019-08-24T14:15:22Z",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "sex": "unspecified",
    "nhs_number": "string",
    "email": "string",
    "mobile": "string",
    "last_sync_at": "2019-08-24T14:15:22Z",
    "full_name": "string",
    "contact_emails": [ … ],
    "registered_practitioner_name": "string",
    "notes": "string",
    "membership_scheme_names": [ … ],
    "address": { … },
    "verification_credentials_list": [ … ]
  },
  "form_response": {
    "id": 0,
    "form_id": 0,
    "client_id": 0,
    "appointment_id": 0,
    "invoice_id": 0,
    "practice_group_id": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "string",
    "hidden": true,
    "emis_file_record_at": "string",
    "short_link_id": 0,
    "admin_id": 0,
    "write_to_record_error": "string",
    "title": "string",
    "submitted_at": "string",
    "form_questions_responses": [ … ],
    "form": { … },
    "write_to_record_status": "string"
  },
  "appointment": {
    "id": "string",
    "location_id": "string",
    "start_time": "2019-08-24T14:15:22Z",
    "reserved_until": "2019-08-24T14:15:22Z",
    "booking_confirmed_at": "2019-08-24T14:15:22Z",
    "can_be_cancelled": false,
    "can_be_rescheduled": false,
    "cancellation_policy_hours": 0,
    "appointment_template_name": "string",
    "cancelled_at": "2019-08-24T14:15:22Z",
    "confirmed_at": "2019-08-24T14:15:22Z",
    "appointment_source": "string",
    "video": false,
    "in_person": false,
    "telephone": false,
    "location_name": "string",
    "service": "string",
    "source": "string",
    "status": "string",
    "appointment_type_id": "string",
    "duration": 0,
    "patient_uid": "string",
    "practitioner_id": "string",
    "booking_status": "reserved",
    "booking_mechanism": "hero_confirmed",
    "created_at": "string",
    "reason": "string",
    "practitioner_name": "string",
    "communication_method": "string",
    "video_url": "string",
    "rescheduled_at": "string"
  },
  "communication": {
    "id": "string",
    "content": "string",
    "contact_method": "email",
    "write_to_record_timestamp": "string",
    "write_to_record_error": "string",
    "write_to_record_status": "string",
    "short_link": { … },
    "notification": { … }
  },
  "note": {
    "id": 0,
    "description": "string",
    "admin": { … },
    "practice_group_id": 0,
    "archived_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "assignee_id": "string",
  "assignee_type": "string",
  "assignee_name": "string",
  "priority": "lowest",
  "created_at": "string",
  "title": "string",
  "title_sub_text": "string",
  "name": "string",
  "taskable_type": "string",
  "triggered_by": {
    "id": "string",
    "type": "Admin",
    "name": "string"
  },
  "system_alert_details": {
    "type": "emis_alert",
    "title": "string",
    "message": "string",
    "sub_title": "string",
    "action": "string"
  },
  "form_response_id": "string",
  "communication_id": "string",
  "appointment_id": "string",
  "note_id": "string"
}