Preview Data Sheet

POST

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

Returns a preview of a master data sheet’s rows without downloading the full dataset — intended for inspecting large sheets. Supports cursor-based pagination (size, cursor) and column selection (select, a comma-separated list of column names; defaults to all columns).

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

sheetIdstringRequired

1	{
2	"previewMasterDataSheet": {
3	"data": [
4	{
5	"colA": "val",
6	"colB": 42,
7	"row_id": 1
8	},
9	{
10	"colA": "val2",
11	"colB": 99,
12	"row_id": 2
13	}
14	],
15	"meta": {
16	"totalCols": 9,
17	"totalRows": 50234
18	},
19	"page": {
20	"after": null,
21	"next": 50,
22	"size": 50
23	}
24	}
25	}

Authentication

Path parameters

Response