GET

Read Rows

Retrieve data from your spreadsheet with flexible filtering and formatting options.

Basic Usage

To read all data from the API, make GET requests to your Sheet API endpoint. We will parse the entire sheet and present it in JSON format.

Basic GET RequestcURL

# Parsed Format (default)
curl 'https://api.sheetapi.com/sheets/your-sheet-id' \
  -H 'X-Api-Key: your-api-key'

# Raw Format
curl 'https://api.sheetapi.com/sheets/your-sheet-id?_raw=1' \
  -H 'X-Api-Key: your-api-key'

Response Formats

Parsed Format (Default)

Structured JSON objects with column names as keys

[
  {
    "Id": "1",
    "Name": "John Doe",
    "Age": "23",
    "Email": "john@example.com"
  },
  {
    "Id": "2", 
    "Name": "Jane Smith",
    "Age": "34",
    "Email": "jane@example.com"
  }
]

Raw Format

Array of arrays with raw cell values

[
  ["Id", "Name", "Age", "Email"],
  ["1", "John Doe", "23", "john@example.com"],
  ["2", "Jane Smith", "34", "jane@example.com"]
]

Add ?_raw=1 to get raw format

Query Parameters

Parameter	Description	Example
_raw	Return raw array format instead of parsed objects	?_raw=1
_format	Specify response format (records, dict, list, etc.)	?_format=dict
_limit	Limit number of rows returned	?_limit=10
_offset	Skip number of rows before returning data	?_offset=5

Advanced Examples

Pagination

# Get 10 rows, skipping the first 5
curl 'https://api.sheetapi.com/sheets/your-sheet-id?_limit=10&_offset=5' \
  -H 'X-Api-Key: your-api-key'

# Get single row by index (0-based)
curl 'https://api.sheetapi.com/sheets/your-sheet-id/0' \
  -H 'X-Api-Key: your-api-key'

Different Formats

# Dictionary format
curl 'https://api.sheetapi.com/sheets/your-sheet-id?_format=dict' \
  -H 'X-Api-Key: your-api-key'

# List format  
curl 'https://api.sheetapi.com/sheets/your-sheet-id?_format=list' \
  -H 'X-Api-Key: your-api-key'