Smartsheet Rows API

Manage rows within sheets.

OpenAPI Specification

smartsheet-rows-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Smartsheet Columns Rows API
  description: Smartsheet is a SaaS work management and collaboration platform. The Smartsheet REST API v2.0 provides programmatic access to sheets, rows, columns, reports, workspaces, users, attachments, and webhooks. Authentication uses OAuth 2.0 or Bearer API access tokens.
  version: 2.0.0
  contact:
    name: Smartsheet API
    url: https://developers.smartsheet.com/api/smartsheet/openapi
servers:
- url: https://api.smartsheet.com/2.0
  description: Smartsheet REST API (US)
- url: https://api.smartsheet.eu/2.0
  description: Smartsheet REST API (EU)
- url: https://api.smartsheet.au/2.0
  description: Smartsheet REST API (AU)
security:
- ApiToken: []
- OAuth2: []
tags:
- name: Rows
  description: Manage rows within sheets.
paths:
  /sheets/{sheetId}/rows:
    post:
      summary: Add rows
      description: Insert one or more rows into the specified sheet.
      operationId: addRows
      tags:
      - Rows
      parameters:
      - in: path
        name: sheetId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: Rows added.
          content:
            application/json:
              schema:
                type: object
    put:
      summary: Update rows
      description: Update one or more rows in the specified sheet.
      operationId: updateRows
      tags:
      - Rows
      parameters:
      - in: path
        name: sheetId
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: Rows updated.
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      description: Smartsheet API access token sent in the Authorization header as a Bearer token.
    OAuth2:
      type: oauth2
      description: Smartsheet OAuth 2.0 authorization.
      flows:
        authorizationCode:
          authorizationUrl: https://app.smartsheet.com/b/authorize
          tokenUrl: https://api.smartsheet.com/2.0/token
          scopes:
            READ_SHEETS: View sheets
            WRITE_SHEETS: Edit sheets
            SHARE_SHEETS: Share sheets
            DELETE_SHEETS: Delete sheets
            ADMIN_SHEETS: Sheet admin
            ADMIN_WORKSPACES: Workspace admin
            ADMIN_USERS: User admin
            ADMIN_WEBHOOKS: Webhook admin
            READ_USERS: View users
            READ_CONTACTS: View contacts