Skip to main content
GET
Get task

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Path Parameters

id
string
required

Response

Successful response for get task.

id
string
read-only
Minimum string length: 1
created_at
string<date-time>
read-only
modified_at
string<date-time>
read-only
contact
object
read-only
task_type
enum<string>
read-only
Available options:
BILLING_COLLECTION,
BILLING_GET_PAYMENT_METHOD,
BILLING_INQUIRY,
BILLING_UPDATE_PAYMENT_METHOD,
CLINICAL_REVIEW,
CUSTOMER_SERVICE_RECOVERY,
INFORMATION_UPDATE,
INQUIRY_GENERAL,
INQUIRY_PRICING,
INQUIRY_UPCOMING_APPOINTMENT,
INSURANCE_AUTHORIZATION,
INSURANCE_CLAIM,
INSURANCE_VERIFICATION,
MEDICAL_RECORD_REQUEST,
PRODUCT_INQUIRY,
QA_REVIEW,
WEBCHAT_OUTREACH_PATIENT,
VOICECHAT_OUTREACH_PATIENT,
MISSED_CALL_OUTREACH_PATIENT,
PRESCRIPTION_REFILL,
REFERRAL,
SCHEDULING_BOOK_APPOINTMENT,
SCHEDULING_CANCEL_APPOINTMENT,
SCHEDULING_CONFIRM_APPOINTMENT,
SCHEDULING_RESCHEDULE_APPOINTMENT,
SUPERVISOR_HANDOFF,
URGENT_OUTREACH_PATIENT
practice_id
string
read-only
assignee_type
enum<string>
read-only
Available options:
AIMEE,
STAFF
status
enum<string>
read-only
Available options:
CREATED,
COMPLETED,
CANCELLED
due_at
string<date-time> | null
read-only
handoff_at
string<date-time> | null
read-only
completed_at
string<date-time> | null
read-only
cancelled_at
string<date-time> | null
read-only
handoff_reason
enum<string> | null
read-only
Available options:
aimee_initiated,
error,
user_initiated
handoff_notes
string | null
read-only
Minimum string length: 1
completed_by_type
enum<string> | null
read-only
Available options:
AIMEE,
STAFF
patients
object[]
read-only
conversations
string[]
read-only
opportunities
string[]
read-only
appointments
object[]
read-only
task_description
string | null
read-only
Minimum string length: 1
task_type_display
string
read-only
handoff_reason_display
string
read-only
task_category
string
read-only
is_viewed
boolean
read-only
is_high_priority
boolean
read-only
detail
string | null
read-only
Minimum string length: 1