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

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

6 fields
freshnessAlways returnedstring

Allowed values: "fresh", "stale", "building".

generated_atAlways returnedstring

Type: string.

last_materialized_atAlways returnedstring | null

Type: string | null.

next_actionsAlways returnedarray<object>

Maximum items: 100.

Nested fields (5)

countAlways returnedinteger

Minimum: 0.

hrefAlways returnedstring

Type: string.

kindAlways returnedstring

Allowed values: "create_filer", "add_recipients", "review_recipients", "preview_pdfs", "release_order", "review_order", "view_orders".

labelAlways returnedstring

Type: string.

severityAlways returnedstring

Allowed values: "info", "warning", "danger", "success".

summaryAlways returnedobject

Unknown fields are rejected.

Nested fields (11)

active_recipient_countAlways returnedinteger

Minimum: 0.

filer_countAlways returnedinteger

Minimum: 0.

orders_completed_countAlways returnedinteger

Minimum: 0.

orders_needs_attention_countAlways returnedinteger

Minimum: 0.

orders_processing_countAlways returnedinteger

Minimum: 0.

orders_total_countAlways returnedinteger

Minimum: 0.

release_ready_recipient_countAlways returnedinteger

Minimum: 0.

released_recipient_countAlways returnedinteger

Minimum: 0.

tin_match_needed_countAlways returnedinteger

Minimum: 0.

tin_match_pending_countAlways returnedinteger

Minimum: 0.

unvalidated_recipient_countAlways returnedinteger

Minimum: 0.

tax_yearAlways returnedinteger | null

Allowed values: 2022, 2023, 2024, 2025, 2026.

Complete response schema: ApiDashboardSummary

Structure · HTTP 200
{
  "data": {
    "freshness": "string",
    "generated_at": "string",
    "last_materialized_at": "string | null",
    "next_actions": "array<object>",
    "summary": "object",
    "tax_year": "integer | null"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.