Skip to main content
GET
List Lien Filing Import Batches

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Response

List of bulk lien import batches.

id
string<uuid>
required

The batch's id, used to poll status and fetch per-row results.

name
string
required

The name of the batch, taken from the uploaded file.

Example:

"q3-portfolio-liens.csv"

state
enum<string>
required

Processing state of the batch.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"PENDING"

total_count
integer
required

Rows read from the uploaded CSV, excluding blank lines.

Example:

100

created_at
string<date-time>
required

When the batch was accepted.

completed_count
integer
required
read-only

Rows processed so far, whatever their outcome — the sum of the four outcome counts.

Examples:

0

50

progress
number
required
read-only

Fraction of the uploaded rows processed so far, in [0, 1].

Examples:

0

0.5

1

imported_count
integer
default:0

Rows that resolved against the public record and produced a newly imported filing.

Example:

80

already_imported_count
integer
default:0

Rows naming a lien the organization had already imported; the existing filing is kept.

Example:

15

not_found_count
integer
default:0

Rows whose state and filing number matched nothing in the public record.

Example:

4

invalid_row_count
integer
default:0

Rows rejected before resolution (unparseable state, blank filing number, and the like).

Example:

1

error
string | null

Why the batch last failed, as a human-readable message. Set when the state is FAILED; a batch that failed once and succeeded on a resume can still carry the message from that attempt, so read it alongside the state rather than as a failure signal on its own.

Example:

"The uploaded CSV could not be read from storage."