E-File Magic

Dashboard

Read dashboard totals

Read the saved account dashboard for a selected tax year.

POST
/api/v1/dashboard/summary
Authentication
OAuth 2.0 access token
Required scopes
filers.readrecipients.readorders.read
Idempotency key
Not required
Rate-limit cost
2 units

How to use this endpoint

Requires filers.read, recipients.read and orders.read, plus access to all filers. A connection restricted to selected filers must use filing readiness for an allowed filer.

Counts use the normal dashboard projection and may lag edits. Preserve generated_at and freshness when presenting them. Reading a summary does not submit an order.

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/dashboard/summary' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace placeholders with your own values. Use the API resource origin provided for your environment.

Create request.json using the documented fields. Field descriptions are not sample values.