{"openapi":"3.1.0","info":{"title":"Smartsheet (BYOK) API","version":"0.1.0","description":"Smartsheet (BYOK) lets an AI assistant read your own Smartsheet data through the Smartsheet API with a key you supply (API access token). Read-only: 10 tools (get_current_user, list_sheets, get_sheet, list_sheet_columns, get_row, list_reports, get_report, list_dashboards, list_workspaces, search_everything). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-smartsheet.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-smartsheet/docs"},"termsOfService":"https://connectorbay.com/byok-smartsheet/terms"},"servers":[{"url":"https://byok-smartsheet.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-smartsheet/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the Smartsheet user the token belongs to: name, email, role, admin flags, sheet count, time zone and account name. ","description":"Show the Smartsheet user the token belongs to: name, email, role, admin flags, sheet count, time zone and account name. Use for \"Which Smartsheet user and account is my token connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_userArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sheets":{"post":{"operationId":"list_sheets","summary":"List the Smartsheet sheets the user can access with name, access level, version and last-modified time, 100 per page by ","description":"List the Smartsheet sheets the user can access with name, access level, version and last-modified time, 100 per page by default. Use for \"Which Smartsheet sheets can I open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"modified_since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only sheets modified on or after this ISO 8601 date and time, for example 2026-10-01T00:00:00Z.","title":"Modified Since"}},"title":"list_sheetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_sheet":{"post":{"operationId":"get_sheet","summary":"Get one Smartsheet sheet: its columns and a page of rows with each cell's value and display value. Use page and page_siz","description":"Get one Smartsheet sheet: its columns and a page of rows with each cell's value and display value. Use page and page_size to read large sheets. Use for \"What rows are in my Smartsheet launch plan sheet\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sheet_id":{"description":"Smartsheet sheet ID (a number, from list_sheets or the sheet's properties).","title":"Sheet Id","type":"integer"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (1 to 500).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page of rows, starting at 1.","title":"Page"},"column_ids":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated column IDs to return; leave out for all columns.","title":"Column Ids"},"rows_modified_since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only rows modified since this ISO 8601 date and time.","title":"Rows Modified Since"}},"required":["sheet_id"],"title":"get_sheetArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sheet_columns":{"post":{"operationId":"list_sheet_columns","summary":"List the columns of a Smartsheet sheet with title, type, position, primary flag and hidden/locked flags. Column IDs iden","description":"List the columns of a Smartsheet sheet with title, type, position, primary flag and hidden/locked flags. Column IDs identify cells in rows. Use for \"What columns does my Smartsheet launch plan sheet have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sheet_id":{"description":"Smartsheet sheet ID (a number, from list_sheets or the sheet's properties).","title":"Sheet Id","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many items per page (1 to 100).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["sheet_id"],"title":"list_sheet_columnsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_row":{"post":{"operationId":"get_row","summary":"Get one row of a Smartsheet sheet with every cell's value and display value. Use for \"Show me this row of my Smartsheet ","description":"Get one row of a Smartsheet sheet with every cell's value and display value. Use for \"Show me this row of my Smartsheet sheet\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"sheet_id":{"description":"Smartsheet sheet ID (a number, from list_sheets or the sheet's properties).","title":"Sheet Id","type":"integer"},"row_id":{"description":"Smartsheet row ID (a number, from get_sheet).","title":"Row Id","type":"integer"}},"required":["sheet_id","row_id"],"title":"get_rowArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_reports":{"post":{"operationId":"list_reports","summary":"List the Smartsheet reports the user can access with name, access level and whether it is a summary report. Use for \"Whi","description":"List the Smartsheet reports the user can access with name, access level and whether it is a summary report. Use for \"Which Smartsheet reports can I open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_reportsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_report":{"post":{"operationId":"get_report","summary":"Get one Smartsheet report: its columns and a page of rows with cell values. Use for \"What rows does my Smartsheet Q3 sta","description":"Get one Smartsheet report: its columns and a page of rows with cell values. Use for \"What rows does my Smartsheet Q3 status report show\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"report_id":{"description":"Smartsheet report ID (a number, from list_reports).","title":"Report Id","type":"integer"},"page_size":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many rows to return (1 to 500).","title":"Page Size"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page of rows, starting at 1.","title":"Page"}},"required":["report_id"],"title":"get_reportArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dashboards":{"post":{"operationId":"list_dashboards","summary":"List the Smartsheet dashboards (sights) the user can access with name, access level and last-modified time. Use for \"Whi","description":"List the Smartsheet dashboards (sights) the user can access with name, access level and last-modified time. Use for \"Which Smartsheet dashboards can I open\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"max_items":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many dashboards to return (1 to 1000).","title":"Max Items"},"last_key":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token for the next page: the lastKey value of the previous answer. Leave out for the first page.","title":"Last Key"}},"title":"list_dashboardsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the Smartsheet workspaces the user can access with name and access level. Use for \"Which Smartsheet workspaces am I","description":"List the Smartsheet workspaces the user can access with name and access level. Use for \"Which Smartsheet workspaces am I part of\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"max_items":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many workspaces to return (1 to 1000).","title":"Max Items"},"last_key":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token for the next page: the lastKey value of the previous answer. Leave out for the first page.","title":"Last Key"}},"title":"list_workspacesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_everything":{"post":{"operationId":"search_everything","summary":"Search all Smartsheet sheets, rows, reports, dashboards, workspaces and discussions the user can see for a text. Returns","description":"Search all Smartsheet sheets, rows, reports, dashboards, workspaces and discussions the user can see for a text. Returns matching text and object ids. Use for \"Find everything in Smartsheet that mentions the launch budget\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Text to search for; wrap in double quotes for an exact phrase.","maxLength":200,"title":"Query","type":"string"}},"required":["query"],"title":"search_everythingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}