Skip to content
DocsToSheets

List table rows

GET
/api/mailboxes/{mailboxId}/rows
 
curl --request GET \
  --url https://app.docstosheets.com/api/mailboxes/example/rows \
  --header 'Authorization: Bearer <token>'

Returns all projected table rows for one split of a mailbox: the flat, spreadsheet-shaped view of the extracted data. The whole split is returned in one response.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
mailboxId
required
string

The mailbox ID.

Query Parameters

Section titled “Query Parameters ”
section
string
nullable

The repeating section (group id) to project; omit for the header table.

split
string
nullable

The split value to load; omit for mailboxes without split keys.

Responses

Section titled “ Responses ”

200

Section titled “200 ”
Media type application/json

Flat table rows for one split of a mailbox (header table, or one repeating section with header values merged in), projected server-side from extractions and the current config. The whole split is returned at once — filtering and virtualization happen on the client.

object
section

The section (group id) these rows belong to; null for the header table.

string
nullable
split

The split these rows belong to; null for a mailbox without split keys.

string
nullable
columns
required
Array<object>
object
key
required
string
label
required
string
type
required

Canonical field type vocabulary, serialized lowercase (text, number, integer, currency, date, time, datetime, boolean, enum, address) — identical tokens in C#, TypeScript, the renderer, and the extraction prompt. Integer/Time/Datetime/Enum semantics (normalization, prompts, controls) land in a later phase.

string
Allowed values: text number integer currency date time datetime boolean enum address
unit
string
nullable
isHeaderField
required
boolean
rows
required
Array<object>
object
documentId
required
string
extractionId
required
string
extractedAt
required
string format: date-time
rowIndex
required
integer format: int32
validationStatus
required
string
Allowed values: valid warning invalid
validationIssues
required
Array<object>

A validation problem found in an extracted value.

object
fieldKey
required

The field the issue applies to.

string
sectionId

The repeating section containing the field; null for header fields.

string
nullable
rowIndex

The zero-based row index within the section; null for header fields.

integer format: int32
nullable
severity
required
One of:
string
Allowed values: warning error
code
required

Machine-readable issue code.

string
message
required

Human-readable explanation.

string
values
required
object
key
additional properties
capped
required

True when the split exceeds the row cap and older rows were omitted.

boolean
Example 
{
  "columns": [
    {
      "type": "text"
    }
  ],
  "rows": [
    {
      "validationStatus": "valid",
      "validationIssues": [
        {
          "fieldKey": "total",
          "severity": "warning",
          "code": "required_missing",
          "message": "Required field has no value."
        }
      ]
    }
  ]
}

400

Section titled “400 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404 ”
Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
nullable
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}