Get an import
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/imports/{id}Costs 1 rate-limit point · Rate limits
Read one CSV import: its state (queued, running, stalled, failed, completed) and row progress.
state is queued (accepted, waiting in the job queue for a worker), running (rows are finishing), stalled (nothing moved for stall_after_seconds; stalled_reason not_started means it never left the queue, no_progress means it started and stopped), failed or completed. A queued import with rows_done 0 is waiting, not broken: when the queue is busy an import can wait several minutes before its first row. Stalled imports are retried automatically within about 10 minutes. rows_done = rows_succeeded + rows_failed; a completed import can have failed rows (bad SKU, invalid email). Timestamps are UTC; waited_seconds is the time from created_at to started_at (or until now while queued), idle_seconds the time since anything last moved. state=open lists every import not yet completed or failed.
Also searched asimport statuscheck importpoll importimport progress
Path parameters
idstringRequiredThe import's ID, from the call that started it or
GET /account/imports.
Returns
The import object.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe action refused the request for a reason that is not a single bad field.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/account/imports/string" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/imports/string", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/account/imports/string",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/imports/string")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": "string",
"name": "string",
"type": "string",
"state": "queued",
"stalled_reason": "not_started",
"rows_total": 1,
"rows_done": 1,
"rows_succeeded": 1,
"rows_failed": 1,
"rows_pending": 1,
"percent_done": 1,
"created_at": "2026-01-15T09:30:00Z",
"started_at": "2026-01-15T09:30:00Z",
"last_progress_at": "2026-01-15T09:30:00Z",
"finished_at": null,
"waited_seconds": 1,
"idle_seconds": 1,
"stall_after_seconds": 1
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}