Space/sheets

​
インハウスシートタブ内の行を一覧取得

カーソルページネーションは保存された行の順序に従います。デフォルトの limit は 100、最大値は 1000 です。オプションの CSV および head/tail サンプリングは、リクエストされたページ内に適用されます。

GET
/v1/space/sheets/{sheet_id}/tabs/{tab_id}/rows
curl -X GET "https://api.orchestor.io/v1/space/sheets/%3Csheet_id%3E/tabs/%3Ctab_id%3E/rows?limit=100&as=rows&max_rows=1000&sample=head" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "csv": "<string>",  "data": [    {      "id": "<string>",      "parentId": "<string>",      "values": {}    }  ],  "has_more": true,  "next_cursor": "<string>",  "omitted_rows": 0,  "total_rows": 0,  "truncated": true,  "updated_at": "2026-01-01T00:00:00Z"}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

パスパラメータ

sheet_idstringpath必須
パターン
^sht_[a-f0-9]{24}$
tab_idstringpath必須
文字数
≥ 1, ≤ 256

クエリパラメータ

limitintegerqueryデフォルト:100
値の範囲
≥ 1, ≤ 1000
cursorstringquery
文字数
≥ 1, ≤ 256
asstringenum<string>queryデフォルト:rows
許可される値
rowscsv
max_rowsintegerqueryデフォルト:1000
値の範囲
≥ 1, ≤ 10000
samplestringenum<string>queryデフォルト:head
許可される値
headhead_and_tail

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

レスポンス

application/json

行、次のカーソル、およびシートの同時実行トークンです。

csvstring | null必須
dataobject[]必須
data[]object
追加プロパティ
許可しない
data[].idstring必須
文字数
≥ 1, ≤ 256
data[].parentIdstring
文字数
≥ 1, ≤ 256
data[].valuesobject
data[].values.*string | number | boolean | string[]

以下のいずれかに一致

形式 1: string

data[].values.*string

形式 2: number

data[].values.*number

形式 3: boolean

data[].values.*boolean

形式 4: string[]

data[].values.*[]string
has_moreboolean必須
next_cursorstring | null必須
omitted_rowsinteger必須
total_rowsinteger必須
truncatedboolean必須
updated_atstring必須形式:date-time