Skip to main content
POST
Import Rows

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json
rows
any[]
required

Arbitrary JSON values stored unchanged, one import row per element. Null, scalars, arrays and objects are accepted.

Required array length: 1 - 1000 elements
rowsGzipBase64
string

Alternative to rows for large indivisible source records. Standard padded base64 of gzip-compressed UTF-8 JSON containing the complete rows array. Send exactly one of rows or rowsGzipBase64. The compressed bytes must not exceed 16 MiB, and the expanded JSON must not exceed 128 MiB. The decoded array follows the same 1–1000 row validation and preserves every JSON value. Malformed or oversized payloads are rejected before any rows are stored. Authentication precedes decompression.

Required string length: 1 - 22369624
importBatch
string | null

Optional non-blank batch key for selecting these rows later.

Minimum string length: 1

Response

All rows stored, without transforming or writing entities.

importRowIds
string<uuid>[]
required
importBatch
string | null
required