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

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
catalog_viewAlways returnedstring

Allowed values: "inventory", "filer", "recipient".

filer_classesAlways returnedarray<object>

Type: array<object>.

Nested fields (4)

class_codeAlways returnedstring

Type: string.

class_labelAlways returnedstring

Type: string.

filer_classAlways returnedstring

Type: string.

schema_familyAlways returnedstring

Type: string.

filer_fieldsAlways returnedarray<object>

Type: array<object>.

Nested fields (9)

class_codeAlways returnedstring

Type: string.

class_labelAlways returnedstring

Type: string.

field_idsAlways returnedarray<string>

Type: array<string>.

fieldsAlways returnedarray<object>

Type: array<object>.

Nested fields (28)

amount_semanticsMay be omittedstring

Type: string.

annual_change_reasonMay be omittedstring

Type: string.

applicability_rule_idMay be omittedstring

Type: string.

box_refMay be omittedstring

Type: string.

cardinalityAlways returnedstring

Type: string.

descriptionMay be omittedstring

Type: string.

display_labelMay be omittedstring

Type: string.

display_orderAlways returnedinteger

Type: integer.

exposureAlways returnedobject

Unknown fields are rejected.

Nested fields (7)

api_readableAlways returnedboolean

Type: boolean.

api_writableAlways returnedboolean

Type: boolean.

import_acceptedAlways returnedboolean

Type: boolean.

operator_editableAlways returnedboolean

Type: boolean.

operator_visibleAlways returnedboolean

Type: boolean.

print_includedAlways returnedboolean

Type: boolean.

server_derivedAlways returnedboolean

Type: boolean.

field_idAlways returnedstring

Type: string.

group_idAlways returnedstring

Type: string.

help_textAlways returnedstring

Type: string.

import_aliasesAlways returnedarray<string>

Type: array<string>.

input_kindAlways returnedstring

Type: string.

labelAlways returnedstring

Type: string.

max_lenAlways returnedinteger

Type: integer.

normalizersAlways returnedarray<string>

Type: array<string>.

output_scopeAlways returnedstring

Type: string.

repeat_group_idMay be omittedstring

Type: string.

repeat_group_max_itemsMay be omittedinteger

Type: integer.

repeatedAlways returnedboolean

Type: boolean.

requiredAlways returnedboolean

Type: boolean.

sectionAlways returnedstring

Type: string.

source_provenanceAlways returnedstring

Type: string.

special_handlingAlways returnedarray<string>

Type: array<string>.

storage_typeAlways returnedstring

Type: string.

unique_itemsAlways returnedboolean

Type: boolean.

validatorsAlways returnedarray<string>

Type: array<string>.

filer_classAlways returnedstring

Type: string.

schema_familyAlways returnedstring

Type: string.

schema_releaseAlways returnedstring

Type: string.

schema_revAlways returnedinteger

Type: integer.

tax_yearAlways returnedinteger

Type: integer.

recipient_fieldsAlways returnedarray<object>

Type: array<object>.

Nested fields (30)

app_supportAlways returnedstring

Type: string.

class_codeAlways returnedstring

Type: string.

class_labelAlways returnedstring

Type: string.

common_field_idsAlways returnedarray<string>

Type: array<string>.

correction_supportedAlways returnedboolean

Type: boolean.

editing_supportedAlways returnedboolean

Type: boolean.

field_idsAlways returnedarray<string>

Type: array<string>.

fieldsAlways returnedarray<object>

Type: array<object>.

Nested fields (28)

amount_semanticsMay be omittedstring

Type: string.

annual_change_reasonMay be omittedstring

Type: string.

applicability_rule_idMay be omittedstring

Type: string.

box_refMay be omittedstring

Type: string.

cardinalityAlways returnedstring

Type: string.

descriptionMay be omittedstring

Type: string.

display_labelMay be omittedstring

Type: string.

display_orderAlways returnedinteger

Type: integer.

exposureAlways returnedobject

Unknown fields are rejected.

Nested fields (7)

api_readableAlways returnedboolean

Type: boolean.

api_writableAlways returnedboolean

Type: boolean.

import_acceptedAlways returnedboolean

Type: boolean.

operator_editableAlways returnedboolean

Type: boolean.

operator_visibleAlways returnedboolean

Type: boolean.

print_includedAlways returnedboolean

Type: boolean.

server_derivedAlways returnedboolean

Type: boolean.

field_idAlways returnedstring

Type: string.

group_idAlways returnedstring

Type: string.

help_textAlways returnedstring

Type: string.

import_aliasesAlways returnedarray<string>

Type: array<string>.

input_kindAlways returnedstring

Type: string.

labelAlways returnedstring

Type: string.

max_lenAlways returnedinteger

Type: integer.

normalizersAlways returnedarray<string>

Type: array<string>.

output_scopeAlways returnedstring

Type: string.

repeat_group_idMay be omittedstring

Type: string.

repeat_group_max_itemsMay be omittedinteger

Type: integer.

repeatedAlways returnedboolean

Type: boolean.

requiredAlways returnedboolean

Type: boolean.

sectionAlways returnedstring

Type: string.

source_provenanceAlways returnedstring

Type: string.

special_handlingAlways returnedarray<string>

Type: array<string>.

storage_typeAlways returnedstring

Type: string.

unique_itemsAlways returnedboolean

Type: boolean.

validatorsAlways returnedarray<string>

Type: array<string>.

filer_classAlways returnedstring

Type: string.

fire_fileableAlways returnedboolean

Type: boolean.

fire_target_releaseMay be omittedstring

Type: string.

fire_target_schema_revMay be omittedinteger

Type: integer.

fire_translation_contract_idMay be omittedstring

Type: string.

fire_unavailable_reasonMay be omittedstring

Type: string.

form_field_idsAlways returnedarray<string>

Type: array<string>.

form_idAlways returnedstring

Type: string.

form_labelAlways returnedstring

Type: string.

import_supportedAlways returnedboolean

Type: boolean.

iris_fileableAlways returnedboolean

Type: boolean.

iris_target_releaseMay be omittedstring

Type: string.

iris_target_schema_revMay be omittedinteger

Type: integer.

iris_translation_contract_idMay be omittedstring

Type: string.

iris_unavailable_reasonMay be omittedstring

Type: string.

presentation_groupsAlways returnedarray<object>

Type: array<object>.

Nested fields (5)

columnsAlways returnedinteger

Type: integer.

descriptionAlways returnedstring

Type: string.

field_idsAlways returnedarray<string>

Type: array<string>.

group_idAlways returnedstring

Type: string.

titleAlways returnedstring

Type: string.

print_supportedAlways returnedboolean

Type: boolean.

schema_familyAlways returnedstring

Type: string.

schema_releaseAlways returnedstring

Type: string.

schema_revAlways returnedinteger

Type: integer.

support_reasonAlways returnedstring

Type: string.

tax_yearAlways returnedinteger

Type: integer.

schema_familyAlways returnedstring

Type: string.

validator_catalogAlways returnedarray<object>

Type: array<object>.

Nested fields (3)

descriptionAlways returnedstring

Type: string.

input_kindAlways returnedstring

Type: string.

validator_idAlways returnedstring

Type: string.

Complete response schema: PlatformFormFieldCatalogResponse

Structure · HTTP 200
{
  "data": {
    "catalog_view": "string",
    "filer_classes": "array<object>",
    "filer_fields": "array<object>",
    "recipient_fields": "array<object>",
    "schema_family": "string",
    "validator_catalog": "array<object>"
  },
  "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.