Imports
Read import row results
Review the results of processing an imported spreadsheet.
/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
How to use this endpoint
Row diagnostics are available after the submission is completed or failed. Tax ID values are redacted. Use the documented row selectors to retrieve further results.
This public import-row endpoint keeps its documented row-array contract. The signed-in accounting integration results screen uses a separate terminal-only diagnostics contract with items and next_cursor; its 25-record Previous/Next navigation does not change this endpoint or add a total result count.
curl --request GET 'https://api.efilemagic.com/api/v1/imports/submissions/rows/list' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'submission_id=<submission_id>' \
--data-urlencode 'limit=25'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
3 fieldsquery.submission_idRequiredstring (uuid)
Import submission ID returned when the import was created.
query.statusOptionalstring
Allowed values: "staged", "validated", "pushed", "failed", "dead_letter".
query.limitOptionalinteger
Maximum number of results requested for this page. Minimum: 1. Maximum: 100.
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 GET 'https://api.efilemagic.com/api/v1/imports/submissions/rows/list' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'submission_id=<submission_id>' \
--data-urlencode 'limit=25'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
3 fieldsitemsAlways 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.
{
"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.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.