API Documentation

Quick Start

Get started with Sheets.Systems API in 3 simple steps:

  1. Get your API Key

    Create an API key from your dashboard after signing in.

  2. Make your first API call 
    curl -X GET "https://api.sheets.systems/v1/sheets/{sheetId}/data" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json"
  3. Handle the response 
    {
    "success": true,
    "data": {
        "values": [
            ["Name", "Email", "Phone"],
            ["John Doe", "john@example.com", "123-456-7890"]
        ]
    }
}

Authentication

All API requests require an API key. Include your key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Sheet Operations

Get Sheet Information

GET /sheets/{sheetId}/info

Parameters:

  • includeHeaders (optional): Boolean to include column headers

Create New Sheet

POST /sheets/{sheetId}/tabs

Request Body:

{
    "title": "New Sheet Name"
}

Row Operations

Find Row

GET /sheets/{sheetId}/rows/find

Query Parameters:

{
    "criteria": {
        "column_name": "value"
    }
}

Update Row

PUT /sheets/{sheetId}/rows/update-by-criteria

Request Body:

{
    "criteria": {
        "column_name": "value"
    },
    "updates": {
        "column_to_update": "new_value"
    }
}

Column Operations

Add Column

POST /sheets/{sheetId}/columns

Request Body:

{
    "columnName": "New Column",
    "defaultValue": ""
}

Rate Limiting

Rate limits vary by plan:

  • Free Plan: 100 requests/month
  • Pro Plan: 5,000 requests/month
  • Enterprise Plan: Custom limits

Rate limit headers are included in all responses:

X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4990
X-RateLimit-Reset: 1635724800

Error Codes

Code Description
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid API key
403 Forbidden - Access denied
429 Too Many Requests - Rate limit exceeded