Views

List views by Sheet

GET
Returns all views for the sheet

Query parameters

sheetIdstringRequired
The associated sheet ID of the view.
pageSizeintegerOptional
Number of prompts to return in a page (default 10)
pageNumberintegerOptional
Based on pageSize, which page of prompts to return

Response

This endpoint returns an object
data
list of objects
A view
pagination
objectOptional
pagination info

Errors

GET
1curl -G https://api.x.flatfile.com/v1/views \
2 -H "Authorization: Bearer <token>" \
3 -d sheetId=us_sh_YOUR_ID
1{
2 "data": [
3 {
4 "id": "us_vi_YOUR_ID",
5 "sheetId": "us_sh_YOUR_ID",
6 "name": "My View",
7 "config": {
8 "sortField": "email",
9 "sortDirection": "asc",
10 "filter": "error",
11 "filterField": "email",
12 "q": "firstname like %John%"
13 },
14 "createdBy": "us_usr_YOUR_ID"
15 }
16 ],
17 "pagination": {
18 "currentPage": 3,
19 "pageCount": 50,
20 "totalCount": 100
21 }
22}