Introduction

Welcome to the Sheet Ninja API reference. Sheet Ninja turns Google Sheets into a REST-style API, allowing you to read, create, update, and delete rows in a worksheet using simple HTTP endpoints. Each worksheet in your project can be enabled as an API and interacted with like a lightweight database. This section documents how Sheet Ninja endpoints are structured, how data is mapped, and what to expect when working with rows. The Sheet Ninja API lets you interact with Google Sheets using REST-style endpoints.

---

​

How the API is organized

Sheet Ninja APIs are organized around projects, worksheets, and rows.

• A project represents a single Google Sheets workbook
• Each worksheet (tab) within that workbook can be exposed as an API
• Each row in a worksheet represents a single record

Once a worksheet is enabled, Sheet Ninja automatically provides a set of endpoints for working with its rows.

---

​

Available endpoints

For each enabled worksheet, Sheet Ninja provides the following endpoints:

• List Rows – Retrieve multiple rows from a worksheet
• Get Individual Row – Retrieve a single row by its row number
• Add Row – Append a new row to the worksheet
• Update Row – Update one or more fields on an existing row
• Delete Row – Permanently remove a row

These endpoints are surfaced directly in the Sheet Ninja dashboard and update in real time as your sheet changes.

---

​

Row identification

Rows are identified by their row number in the worksheet.

• Row 1 is always treated as the header row
• Data rows start at row 2
• Row numbers are used when fetching, updating, or deleting individual rows

Because row numbers reflect the sheet’s current state, inserting or deleting rows directly in Google Sheets may change row numbering.

---

​

Data mapping

Sheet Ninja maps spreadsheet data to structured API responses using the following rules:

• Column headers define field names
• Each row maps to a single object
• Empty cells are returned as empty or null values
• Extra fields not present in the sheet are ignored
• Updates only affect the fields you provide

Your Google Sheet remains the source of truth at all times.

---

​

Pagination and limits

When listing rows, responses may be paginated to ensure reliability and performance.

• You can control how many rows are returned per request
• Pagination helpers are included in responses to make iterating easy
• Free and paid plans have different row limits per request

This approach prevents timeouts and keeps large sheets fast and usable, especially when integrating with automation tools or AI systems :contentReference[oaicite:1]index=1

---

​

Authentication

Depending on your project settings, endpoints may require authentication.

• Public endpoints allow read access without authentication
• Protected endpoints require a valid API key
• Write operations typically require authentication

Authentication behavior is configured per project. See the Authentication section for full details.

---

​

What’s next

Use the endpoint pages in this section to learn how each operation behaves in detail, including supported parameters and response behavior. If you’re new to Sheet Ninja, start with the Quickstart to set up your first project and enable your first API.

---

This introduction is intentionally conceptual. Individual endpoint pages contain operation-specific details.