> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.staple.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server.

# Preview Data Sheet

POST https://api.staple.io/v2/master-data/{sheetId}/preview

Preview for large datasets

Reference: https://docs.staple.ai/api-reference/v2/master-data/preview-data-sheet

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: v2
  version: 1.0.0
paths:
  /v2/master-data/{sheetId}/preview:
    post:
      operationId: previewDataSheet
      summary: Preview Data Sheet
      description: Preview for large datasets
      tags:
        - masterData
      parameters:
        - name: sheetId
          in: path
          required: true
          schema:
            type: string
        - name: x-api-key
          in: header
          description: API key issued by Staple.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Master Data_previewDataSheet_Response_200'
servers:
  - url: https://api.staple.io
    description: https://api.staple.io
components:
  schemas:
    Master Data_previewDataSheet_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Master Data_previewDataSheet_Response_200
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key issued by Staple.
    bearerAuth:
      type: http
      scheme: bearer
      description: JWT obtained from the login endpoint.

```

## Examples



**Response**

```json
{
  "previewMasterDataSheet": {
    "data": [
      {
        "colA": "val",
        "colB": 42,
        "row_id": 1
      },
      {
        "colA": "val2",
        "colB": 99,
        "row_id": 2
      }
    ],
    "meta": {
      "totalCols": 9,
      "totalRows": 50234
    },
    "page": {
      "after": null,
      "next": 50,
      "size": 50
    }
  }
}
```

**SDK Code**

```python Preview Data Sheet
import requests

url = "https://api.staple.io/v2/master-data/sheetId/preview"

headers = {"x-api-key": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Preview Data Sheet
const url = 'https://api.staple.io/v2/master-data/sheetId/preview';
const options = {method: 'POST', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Preview Data Sheet
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staple.io/v2/master-data/sheetId/preview"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Preview Data Sheet
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/master-data/sheetId/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Preview Data Sheet
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/master-data/sheetId/preview")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Preview Data Sheet
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/master-data/sheetId/preview', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Preview Data Sheet
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/master-data/sheetId/preview");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Preview Data Sheet
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/master-data/sheetId/preview")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```