BlazeSheets
API Reference

Read rows

GET
/v1/{apiId}

Reads datasource rows when the API grants read. Supports pagination (limit/offset), sorting (sortColumn/sortDirection), filtering (filter), field selection (columns), output format (rows|columns|matrix), castNumbers, and worksheet selection ($sheet). If API-key authentication is configured, send the key in X-API-Key or Authorization: Bearer. Domain restrictions, CORS, and rate limits are enforced. Read operations do not require CAPTCHA.

Authorization

X-API-Key<token>

BlazeSheets API key used to access a protected public API.

In: header

Path Parameters

apiId*string
Formatuuid

Query Parameters

$sheet?string

Worksheet tab name (case-sensitive). Defaults to the first sheet when omitted.

Length1 <= length
filter?string

Filter expression: field:op:value with and()/or() groups.

limit?integer
Range1 <= value <= 100000
Default100
offset?|
Range0 <= value
Default0
sortColumn?string
sortDirection?string
Default"asc"

Value in

  • "asc"
  • "desc"
columns?string

Comma-separated field selection.

format?string
Default"rows"

Value in

  • "rows"
  • "columns"
  • "matrix"
castNumbers?string

Comma-separated columns to cast to numbers.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": [    {      "property1": "string",      "property2": "string"    }  ],  "meta": {    "limit": 0,    "offset": 0,    "format": "rows"  }}

Delete a row DELETE

Deletes the record at the 1-based data row number (excluding header) when `delete` is granted. Use `$sheet` to select a worksheet tab (defaults to the first sheet). Authenticate through `X-API-Key` or bearer auth when configured. If delete CAPTCHA is enabled, send `cf-turnstile-response` or `captchaToken` as a query parameter.

Replace a row PUT

Fully replaces the record at the 1-based data row number (excluding header) when `update` is granted. Use `$sheet` to select a worksheet tab (defaults to the first sheet). API keys may use `X-API-Key` or bearer auth. Supply `cf-turnstile-response` or `captchaToken` when update CAPTCHA is enabled. Domain, CORS, and rate limits apply.