curl --request GET \
--url https://api.example.com/api/v1/dashboard{
"user": {
"id": 1,
"first_name": "Jane",
"plan": "pro",
"employment_type": "w2"
},
"assignments": [
{
"id": 1,
"facility": "Memorial Hospital",
"location": "Houston",
"state": "TX",
"status": "active",
"start_date": "2025-01-06",
"end_date": "2025-04-06",
"base_pay": 180000,
"housing_stipend": 175000,
"mie_stipend": 54600
}
],
"taxHome": {
"id": 1,
"address": "123 Main St",
"city": "Nashville",
"state": "TN",
"rent_amount": 120000,
"last_visit_date": "2025-02-01",
"voter_reg": true,
"drivers_license_state": "TN",
"property_rented_out": false
},
"taxHomeDocs": [],
"expenses": [],
"taxHomeCosts": [],
"mileageTrips": [],
"auditReadiness": {
"score": 9,
"total": 11,
"status": "action_needed",
"criteria": [
{ "key": "rent_paid", "label": "Rent being paid", "passed": true },
{ "key": "active_assignment", "label": "Active assignment", "passed": true },
{ "key": "recent_visit", "label": "Recent visit", "passed": true },
{ "key": "voter_reg", "label": "Voter registration", "passed": true },
{ "key": "drivers_license", "label": "Driver's license", "passed": true },
{ "key": "property_status", "label": "Property not rented out", "passed": true },
{ "key": "twelve_month", "label": "12-month rule", "passed": true },
{ "key": "costs_recorded", "label": "Tax home costs", "passed": false },
{ "key": "gsa_compliance", "label": "GSA compliance", "passed": true },
{ "key": "expenses_tracked", "label": "Expenses tracked", "passed": false },
{ "key": "mileage_logged", "label": "Mileage logged", "passed": true }
]
}
}
Retrieve the dashboard summary including audit readiness, stipends, and alerts.
curl --request GET \
--url https://api.example.com/api/v1/dashboard{
"user": {
"id": 1,
"first_name": "Jane",
"plan": "pro",
"employment_type": "w2"
},
"assignments": [
{
"id": 1,
"facility": "Memorial Hospital",
"location": "Houston",
"state": "TX",
"status": "active",
"start_date": "2025-01-06",
"end_date": "2025-04-06",
"base_pay": 180000,
"housing_stipend": 175000,
"mie_stipend": 54600
}
],
"taxHome": {
"id": 1,
"address": "123 Main St",
"city": "Nashville",
"state": "TN",
"rent_amount": 120000,
"last_visit_date": "2025-02-01",
"voter_reg": true,
"drivers_license_state": "TN",
"property_rented_out": false
},
"taxHomeDocs": [],
"expenses": [],
"taxHomeCosts": [],
"mileageTrips": [],
"auditReadiness": {
"score": 9,
"total": 11,
"status": "action_needed",
"criteria": [
{ "key": "rent_paid", "label": "Rent being paid", "passed": true },
{ "key": "active_assignment", "label": "Active assignment", "passed": true },
{ "key": "recent_visit", "label": "Recent visit", "passed": true },
{ "key": "voter_reg", "label": "Voter registration", "passed": true },
{ "key": "drivers_license", "label": "Driver's license", "passed": true },
{ "key": "property_status", "label": "Property not rented out", "passed": true },
{ "key": "twelve_month", "label": "12-month rule", "passed": true },
{ "key": "costs_recorded", "label": "Tax home costs", "passed": false },
{ "key": "gsa_compliance", "label": "GSA compliance", "passed": true },
{ "key": "expenses_tracked", "label": "Expenses tracked", "passed": false },
{ "key": "mileage_logged", "label": "Mileage logged", "passed": true }
]
}
}
curl -H "Authorization: Bearer <token>" \
https://app.taxhomebase.com/api/v1/dashboard
{
"user": {
"id": 1,
"first_name": "Jane",
"plan": "pro",
"employment_type": "w2"
},
"assignments": [
{
"id": 1,
"facility": "Memorial Hospital",
"location": "Houston",
"state": "TX",
"status": "active",
"start_date": "2025-01-06",
"end_date": "2025-04-06",
"base_pay": 180000,
"housing_stipend": 175000,
"mie_stipend": 54600
}
],
"taxHome": {
"id": 1,
"address": "123 Main St",
"city": "Nashville",
"state": "TN",
"rent_amount": 120000,
"last_visit_date": "2025-02-01",
"voter_reg": true,
"drivers_license_state": "TN",
"property_rented_out": false
},
"taxHomeDocs": [],
"expenses": [],
"taxHomeCosts": [],
"mileageTrips": [],
"auditReadiness": {
"score": 9,
"total": 11,
"status": "action_needed",
"criteria": [
{ "key": "rent_paid", "label": "Rent being paid", "passed": true },
{ "key": "active_assignment", "label": "Active assignment", "passed": true },
{ "key": "recent_visit", "label": "Recent visit", "passed": true },
{ "key": "voter_reg", "label": "Voter registration", "passed": true },
{ "key": "drivers_license", "label": "Driver's license", "passed": true },
{ "key": "property_status", "label": "Property not rented out", "passed": true },
{ "key": "twelve_month", "label": "12-month rule", "passed": true },
{ "key": "costs_recorded", "label": "Tax home costs", "passed": false },
{ "key": "gsa_compliance", "label": "GSA compliance", "passed": true },
{ "key": "expenses_tracked", "label": "Expenses tracked", "passed": false },
{ "key": "mileage_logged", "label": "Mileage logged", "passed": true }
]
}
}