Skip to content
calternal docs

Read one in-flight import's safe progress without exposing its source data.

GET
/api/v1/money/imports/jobs/{job_id}
curl --request GET \
  --url https://example.com/api/v1/money/imports/jobs/example \
  --header 'Authorization: Bearer <token>'

Route: /api/v1/money/imports/jobs/{job_id}. Inputs: job_id. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
job_id
required
string

Caller-generated import job UUID

Responses

Section titled “Responses”

200

Section titled “200”

Current import phase and bounded progress

Media typeapplication/json

Safe import progress. It contains counts and a phase only, never source names, amounts or row values (#462, DESIGN §48).

object
completed
required
integer
elapsed_seconds
required
integer format: int64
stage
required
string
total
integer | null
unit
required
string
Examplegenerated
{
  "completed": 1,
  "elapsed_seconds": 1,
  "stage": "example",
  "total": 1,
  "unit": "example"
}

404

Section titled “404”

Job is missing or belongs to another User

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}