E-File Magic

Forms

Read the form catalog

Find supported forms and their exact annual field contracts.

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

Request fields

5 fields
query.viewRequiredstring

Choose inventory to find supported contracts, then filer or recipient to read an exact contract. inventory takes only view. filer also requires filer_class, tax_year and schema_rev. recipient additionally requires form_id. No extra selectors are accepted. Allowed values: "inventory", "filer", "recipient".

query.filer_classOptionalstring

Filer class selected from the form catalog. Allowed values: "app_1099_class", "app_1042s", "ssa_w2".

query.tax_yearOptionalinteger

Tax year of the filer and forms being processed. Allowed values: 2022, 2023, 2024, 2025, 2026.

query.schema_revOptionalinteger

Exact application schema revision selected from the form catalog. Exact admitted application revision; use the returned inventory. Minimum: 1.

query.form_idOptionalstring

Form identifier from the catalog for this tax year and schema revision. Exact admitted form identifier, required only for recipient view.

Headers (1)
AuthorizationRequired
OAuth Bearer token with the listed scopes and current resource authorization.
cURL request
curl --request GET 'https://api.efilemagic.com/api/v1/forms/catalog' \
  --header 'Authorization: Bearer <access-token>' \
  --get \
  --data-urlencode 'view=inventory'

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