{
"result": {
"results": [
{}
],
"total": 123,
"limit": 123,
"offset": 123,
"has_next": true,
"has_previous": true
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "User not found"
}{
"error": "User not found"
}Read imported object rows
Read-only, paginated retrieval of the rows imported into one version of an imported object extractor.
Imported objects are written directly by the import task, not by
extraction-flow hydration, so they have no HydrationComputation
records and cannot be read through
tables/{table_id}/extractor-table-retrieval/. Rows are matched on the
extractor_version_id column of the extractor’s imported-objects table.
What it returns: rows of the extractor’s imported-objects table
(id, provided_id, document_id, json_object,
extractor_version_id, deleted) for the given version. By default
soft-deleted rows (deleted IS NOT NULL) are left out. When the
extractor has no imported-objects table yet (nothing imported), the
response is an empty page.
POST is used only because the request carries a filter and column body: this endpoint never writes.
Filtering:
Keys are column names, optionally suffixed with a lookup: __in or
__iin (case-insensitive) for a list or comma-separated string,
__gt, __gte, __lt, __lte, __isnull, and __icontains. A bare
__icontains key searches every text, JSON and UUID column, or only
those listed under searchColumns. A plain key is an equality match.
Keys naming a column that does not exist are silently ignored. Any
extractor_version_id filter is overridden by the request’s
extractor_version_id, and processing_options is stripped.
Permissions: technical_setup:read on the project.
{
"result": {
"results": [
{}
],
"total": 123,
"limit": 123,
"offset": 123,
"has_next": true,
"has_previous": true
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "User not found"
}{
"error": "User not found"
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
UUID of the extractor
Body
UUID of the imported object extractor version whose rows to return.
Column-level filters. Keys are column names with optional lookups
(__in, __iin, __gt, __gte, __lt, __lte, __isnull,
__icontains). Unknown columns are ignored. Sending
deleted__isnull overrides the default soft-delete filter.
{ "document_id": "82c71787-37e9-42ca-a995-982e2ed53169" }
Column names to return in each row. Omit (or send null / []) to
return every column.
[ "id", "provided_id", "document_id", "json_object" ]
When true, also return rows whose deleted flag is set.
Maximum number of rows to return.
Number of rows to skip for pagination.
Response
Rows retrieved successfully
Wrapper around the paginated list of rows produced by the requested
ExtractorVersion.
Show child attributes
Show child attributes