E-File Magic

Deliverables

List deliverables

Find order deliverables and their current availability.

GET
/api/v1/orders/deliverables/list
Authentication
OAuth 2.0 access token
Required scopes
deliverables.read
Idempotency key
Not required
Rate-limit cost
1 unit

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

Response fields

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (14)

created_atAlways returnedstring (date-time)

Type: string (date-time).

filer_idAlways returnedstring (uuid)

Type: string (uuid).

filer_nameMay be omittedstring | null

Maximum characters: 512.

group_countAlways returnedinteger

Minimum: 0.

last_errorMay be omittedstring | null

Maximum characters: 2048.

materialization_statusAlways returnedstring

Allowed values: "snapshot_pending", "materializing", "ready", "failed", "canceled".

order_idAlways returnedstring (uuid)

Type: string (uuid).

public_order_refMay be omittedstring | null

Maximum characters: 128.

recipient_countAlways returnedinteger

Minimum: 0.

record_countAlways returnedinteger

Minimum: 0.

service_codeAlways returnedstring

Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "irs_spec_file".

service_nameAlways returnedstring

Minimum characters: 1. Maximum characters: 128.

tax_yearAlways returnedinteger

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

updated_atAlways returnedstring (date-time)

Type: string (date-time).

next_cursorMay be omittedstring | null

Maximum characters: 4096.

total_countMay be omittedinteger | null

Minimum: 0.

Complete response schema: ApiV1OrderDeliverableListResponse

Example · HTTP 200
{
  "data": {
    "items": [],
    "next_cursor": null,
    "total_count": null
  },
  "meta": {
    "api_version": "v1",
    "request_id": "example-request-id"
  }
}

No matching records. Synthetic empty-page example. Follow a non-null next_cursor even when items is empty. A null total_count means no count was supplied.