Imports
Get multiple imports
Read several import submissions and identify missing IDs.
/api/v1/imports/submissions/get_many- Authentication
- OAuth 2.0 access token
- Required scopes
imports.read- Idempotency key
- Not required
- Rate-limit cost
- 2 units
How to use this endpoint
Results keep the request order. Each submission must belong to a filer your connection can access.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/imports/submissions/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"submission_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
1 fieldssubmission_idsRequiredarray<string (uuid)>
Import submission IDs to read in request order. Minimum items: 1. Maximum items: 100. Items must be unique.
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.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/imports/submissions/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"submission_ids":["11111111-1111-4111-8111-111111111111"]}'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
2 fieldsitemsAlways returnedarray<object>
Maximum items: 100.
Nested fields (37)
chunk_checksumsMay be omittedarray<object>
Type: array<object>.
completed_atMay be omittedstring (date-time) | null
Type: string (date-time) | null.
content_typeAlways returnedstring
Maximum characters: 128.
created_atAlways returnedstring (date-time)
Type: string (date-time).
created_byAlways returnedobject
Type: object.
created_by_user_idMay be omittedstring (uuid) | null
Type: string (uuid) | null.
default_form_idMay be omittedstring | null
Type: string | null.
default_schema_revMay be omittedinteger | null
Type: integer | null.
default_tax_yearMay be omittedinteger | null
Type: integer | null.
detected_import_kindAlways returnedstring
Determined from uploaded file contents. Native Publication 1220 uses pub1220. Allowed values: "unknown", "standard_template", "inline_filer_template", "pub1220", "advanced_mapping".
file_nameAlways returnedstring
Maximum characters: 180.
filer_idMay be omittedstring (uuid) | null
Type: string (uuid) | null.
final_checksum_sha256May be omittedstring | null
Type: string | null.
imported_countAlways returnedinteger
Minimum: 0.
last_errorMay be omittedstring | null
Maximum characters: 2000.
mappingMay be omittedobject | null
Type: object | null.
next_row_numberAlways returnedinteger
Minimum: 1.
notification_sent_atMay be omittedstring (date-time) | null
Type: string (date-time) | null.
notify_emailMay be omittedstring (email) | null
Type: string (email) | null.
providerAlways returnedstring
Allowed values: "spreadsheet", "custom_spreadsheet", "generic_spreadsheet", "quickbooks_online", "xero", "bill", "zoho_books", "freshbooks", "business_central".
pub1220_corrections_skippedMay be omittedinteger
Minimum: 0.
pub1220_counts_completeMay be omittedboolean
Type: boolean.
pub1220_modeMay be omittedstring
Allowed values: "general_information", "with_details".
rolling_checksum_sha256May be omittedstring | null
Type: string | null.
row_count_processedAlways returnedinteger
Minimum: 0.
row_count_totalAlways returnedinteger
Minimum: 0.
rows_per_chunkAlways returnedinteger
Minimum: 1.
sha256May be omittedstring | null
Pattern: ^[a-f0-9]{64}$
size_bytesAlways returnedinteger
Minimum: 0.
skip_reason_countsMay be omittedobject | null
Additional values: integer.
skipped_countAlways returnedinteger
Minimum: 0.
statusAlways returnedstring
Type: string.
submission_idAlways returnedstring (uuid)
Type: string (uuid).
target_scopeAlways returnedstring
Type: string.
updated_atAlways returnedstring (date-time)
Type: string (date-time).
validation_issue_countAlways returnedinteger
Minimum: 0.
versionAlways returnedinteger
Minimum: 1.
missingAlways returnedarray<string (uuid)>
Maximum items: 100.
{
"data": {
"items": "array<object>",
"missing": "array<string (uuid)>"
},
"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.
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.