List splits

GET

/api/mailboxes/{mailboxId}/splits

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

Returns the mailbox’s splits with extraction counts, newest/highest split value first. A mailbox without split keys returns a single entry with a null split value.

Authorizations

• oauth2
  api.read api.write

Parameters

Path Parameters

mailboxId

required

string

Responses

200

Media type application/json

object

hasSplitKeys

required

False when the mailbox has no split keys (single “All data” entry).

boolean

splits

required

Array<object>

object

splitValue

The raw split value used in queries (e.g. “Year_2025”); null for an unsplit mailbox.

string

nullable

displayLabel

required

Friendly label for the selector (e.g. “2025” or “2025 · TX”).

string

count

required

Number of extracted documents in the split.

integer format: int32

spreadsheetUrl

The split’s workbook link, when it has been exported.

string

nullable

Example ^generated

{
  "hasSplitKeys": true,
  "splits": [
    {
      "splitValue": "example",
      "displayLabel": "example",
      "count": 1,
      "spreadsheetUrl": "example"
    }
  ]
}

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"
}