E-File Magic

Imports

Read import row results

Review the results of processing an imported spreadsheet.

GET
/api/v1/imports/submissions/rows/list
Authentication
OAuth 2.0 access token
Required scopes
imports.readtax_ids.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

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (9)

created_atAlways returnedstring (date-time)

Type: string (date-time).

error_countAlways returnedinteger

Minimum: 0.

has_errorsAlways returnedboolean

Type: boolean.

row_idAlways returnedstring

Type: string.

row_numberAlways returnedinteger

Minimum: 1.

statusAlways returnedstring

Type: string.

submission_idAlways returnedstring (uuid)

Type: string (uuid).

updated_atAlways returnedstring (date-time)

Type: string (date-time).

versionAlways returnedinteger

Minimum: 1.

next_cursorMay be omittedstring | null

Maximum characters: 4096.

total_countMay be omittedinteger | null

Minimum: 0.

Complete response schema: ApiV1ImportRowsListResponse

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.