API Docs
JSON

Readysheet API

Use account-owned API keys to connect your systems to Readysheet.

Bearer Auth

Use an account-owned API key in the Authorization header.

Rate Limited

Requests are limited by the configured tier on each key.

Logged

API requests are captured for later account insight.

Sheet Templates

2 endpoints

Returns published sheet templates available to the authenticated API key.

Parameters
No parameters
Example request
curl -X GET "https://api.readysheet.com/v1/external/sheet_templates" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json"
Responses
StatusDescription
200 Successful response
401 Invalid API key
403 Permission denied
429 Rate limit exceeded
Response schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "lastUpdatedAt": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response example
{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "status": "string",
      "slug": "string",
      "lastUpdatedAt": "string"
    }
  ]
}
Try it
GET /v1/external/sheet_templates

Returns one published sheet template by slug.

Parameters
NameTypeStatus
id string Required
Example request
curl -X GET "https://api.readysheet.com/v1/external/sheet_templates/:id" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json"
Responses
StatusDescription
200 Successful response
401 Invalid API key
403 Permission denied
429 Rate limit exceeded
Response schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "elements": {
          "type": "string"
        }
      }
    }
  }
}
Response example
{
  "data": {
    "id": "string",
    "title": "string",
    "description": "string",
    "elements": "string"
  }
}
Try it
GET /v1/external/sheet_templates/{id}