Search

API Reference

Programmatic access to all sheets with full-text search, filtering, and pagination

Authentication
OpenSheets uses API keys for authentication.
Looking for autonomous API management? Check out PlatPhorm Claws.
All API requests require an API key passed in the Authorization header
curl -X GET "https://sheets.platphormnews.com/api/v1/sheets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Generate an API key from your Settings page.

Base URL
https://sheets.platphormnews.com/api/v1

Endpoints

GET/api/v1/sheets
List all sheets with pagination and filtering
NameTypeDescription
pagenumberPage number (default: 1)
limitnumberResults per page (default: 20, max: 100)
categorystringFilter by category slug
qstringSearch query
GET/api/v1/sheets/:id
Get sheet metadata and data
NameTypeDescription
idstringSheet ID (required)
pagenumberData page (default: 1)
limitnumberRows per page (default: 100)
columnsstringComma-separated column names to include
sortstringColumn to sort by
orderstringSort order: asc or desc
GET/api/v1/sheets/:id/search
Search within a specific sheet
NameTypeDescription
qstringSearch query (required)
columnsstringColumns to search in
limitnumberMax results (default: 50)
POST/api/v1/sheets
Create a new sheet from URL, file, or data
NameTypeDescription
titlestringSheet title (required)
descriptionstringSheet description
urlstringSource URL (Google Sheets, CSV, etc.)
dataarrayArray of row objects
columnsarrayColumn definitions
categorystringCategory slug
GET/api/v1/categories
List all categories

No parameters

Rate Limiting

API requests are rate limited to ensure fair usage:

  • Free100 requests/hour
  • Pro10,000 requests/hour
  • EnterpriseUnlimited

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining