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

Request fields

8 fields
query.filer_idOptionalstring (uuid)

ID of the filer that owns this operation's records.

query.qOptionalstring

Search text used to filter this collection. Maximum characters: 256.

query.service_codeOptionalstring

Service whose deliverable you want to read or request. Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "irs_spec_file".

query.statusOptionalstring

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

query.sort_byOptionalstring

Field used to order results. Allowed values: "updated_at", "relevance".

query.sort_orderOptionalstring

Ascending or descending result order. Allowed values: "asc", "desc".

query.limitOptionalinteger

Maximum number of results requested for this page. Minimum: 1. Maximum: 100.

query.cursorOptionalstring

Opaque next_cursor from the previous page. Keep the other filters unchanged. Minimum characters: 1. Maximum characters: 2048.

Headers (2)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.
cURL request
curl --request GET 'https://api.efilemagic.com/api/v1/orders/deliverables/list' \
  --header 'Authorization: Bearer <access-token>' \
  --get \
  --data-urlencode 'limit=25'

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