Flatfile subpackage_views API
The subpackage_views API from Flatfile — 2 operation(s) for subpackage_views.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flatfile-subpackage-views-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference subpackage_accounts Subpackage Views API
version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_views
paths:
/views:
get:
operationId: list
summary: List views by Sheet
description: Returns all views for the sheet
tags:
- subpackage_views
parameters:
- name: sheetId
in: query
description: The associated sheet ID of the view.
required: true
schema:
$ref: '#/components/schemas/type_commons_SheetId'
- name: pageSize
in: query
description: Number of prompts to return in a page (default 10)
required: false
schema:
type: integer
- name: pageNumber
in: query
description: Based on pageSize, which page of prompts to return
required: false
schema:
type: integer
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ListViewsResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
post:
operationId: create
summary: Create a view
description: Add a new view to the space
tags:
- subpackage_views
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ViewResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ViewCreate'
/views/{viewId}:
get:
operationId: get
summary: Get a view
description: Returns a single view
tags:
- subpackage_views
parameters:
- name: viewId
in: path
description: ID of view to return
required: true
schema:
$ref: '#/components/schemas/type_commons_ViewId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ViewResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
patch:
operationId: update
summary: Update a view
description: Updates a single view
tags:
- subpackage_views
parameters:
- name: viewId
in: path
description: ID of view to update
required: true
schema:
$ref: '#/components/schemas/type_commons_ViewId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ViewResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
'404':
description: Error response with status 404
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Errors'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_views_ViewUpdate'
delete:
operationId: delete
summary: Delete a view
description: Deletes a single view
tags:
- subpackage_views
parameters:
- name: viewId
in: path
description: ID of view to delete
required: true
schema:
$ref: '#/components/schemas/type_commons_ViewId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_commons_Success'
components:
schemas:
type_commons_Error:
type: object
properties:
key:
type: string
message:
type: string
required:
- message
title: Error
type_commons_CommitId:
type: string
description: Commit ID
title: CommitId
type_commons_VersionId:
type: string
description: Version ID
title: VersionId
type_commons_EventId:
type: string
description: Event ID
title: EventId
type_views_ViewCreate:
type: object
properties:
sheetId:
$ref: '#/components/schemas/type_commons_SheetId'
name:
type: string
config:
$ref: '#/components/schemas/type_views_ViewConfig'
required:
- sheetId
- name
- config
title: ViewCreate
type_views_ViewResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_views_View'
required:
- data
title: ViewResponse
type_views_ListViewsResponse:
type: object
properties:
pagination:
$ref: '#/components/schemas/type_commons_Pagination'
data:
type: array
items:
$ref: '#/components/schemas/type_views_View'
required:
- data
title: ListViewsResponse
type_views_View:
type: object
properties:
id:
$ref: '#/components/schemas/type_commons_ViewId'
description: The ID of the view
sheetId:
$ref: '#/components/schemas/type_commons_SheetId'
description: The associated sheet ID of the view
name:
type: string
description: The name of the view
config:
$ref: '#/components/schemas/type_views_ViewConfig'
description: The view filters of the view
createdBy:
type: string
description: ID of the actor who created the view
required:
- id
- sheetId
- name
- config
- createdBy
description: A view
title: View
type_commons_SortField:
type: string
description: Name of field by which to sort records
title: SortField
type_commons_Success:
type: object
properties:
data:
$ref: '#/components/schemas/type_commons_SuccessData'
description: Informs whether or not a request was successful
title: Success
type_commons_Pagination:
type: object
properties:
currentPage:
type: integer
description: current page of results
pageCount:
type: integer
description: total number of pages of results
totalCount:
type: integer
description: total available results
required:
- currentPage
- pageCount
- totalCount
description: pagination info
title: Pagination
type_commons_SuccessData:
type: object
properties:
success:
type: boolean
required:
- success
title: SuccessData
type_commons_Errors:
type: object
properties:
errors:
type: array
items:
$ref: '#/components/schemas/type_commons_Error'
required:
- errors
title: Errors
type_commons_SearchField:
type: string
description: Use this to narrow the searchValue results to a specific field
title: SearchField
type_commons_FilterField:
type: string
description: Use this to narrow the valid/error filter results to a specific field
title: FilterField
type_commons_SearchValue:
type: string
description: Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double quotes ("")
title: SearchValue
type_commons_Filter:
type: string
enum:
- valid
- error
- all
- none
description: Options to filter records
title: Filter
type_views_ViewConfig:
type: object
properties:
versionId:
$ref: '#/components/schemas/type_commons_VersionId'
description: Deprecated, use `commitId` instead.
commitId:
$ref: '#/components/schemas/type_commons_CommitId'
sinceVersionId:
$ref: '#/components/schemas/type_commons_VersionId'
description: Deprecated, use `sinceCommitId` instead.
sinceCommitId:
$ref: '#/components/schemas/type_commons_CommitId'
sortField:
$ref: '#/components/schemas/type_commons_SortField'
sortDirection:
$ref: '#/components/schemas/type_commons_SortDirection'
filter:
$ref: '#/components/schemas/type_commons_Filter'
filterField:
$ref: '#/components/schemas/type_commons_FilterField'
description: Name of field by which to filter records
searchValue:
$ref: '#/components/schemas/type_commons_SearchValue'
searchField:
$ref: '#/components/schemas/type_commons_SearchField'
ids:
type: array
items:
$ref: '#/components/schemas/type_commons_RecordId'
description: The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed.
pageSize:
type: integer
description: Number of records to return in a page (default 10,000)
pageNumber:
type: integer
description: Based on pageSize, which page of records to return (Note - numbers start at 1)
includeCounts:
type: boolean
description: '**DEPRECATED** Use GET /sheets/:sheetId/counts'
includeLength:
type: boolean
description: The length of the record result set, returned as counts.total
includeLinks:
type: boolean
description: If true, linked records will be included in the results. Defaults to false.
includeMessages:
type: boolean
description: Include error messages, defaults to false.
for:
$ref: '#/components/schemas/type_commons_EventId'
description: if "for" is provided, the query parameters will be pulled from the event payload
q:
type: string
description: An FFQL query used to filter the result set
description: The configuration of a view. Filters, sorting, and search query.
title: ViewConfig
type_commons_SheetId:
type: string
description: Sheet ID
title: SheetId
type_commons_ViewId:
type: string
description: View ID
title: ViewId
type_views_ViewUpdate:
type: object
properties:
name:
type: string
config:
$ref: '#/components/schemas/type_views_ViewConfig'
required:
- config
title: ViewUpdate
type_commons_RecordId:
type: string
description: Record ID
title: RecordId
type_commons_SortDirection:
type: string
enum:
- asc
- desc
description: Sort direction - asc (ascending) or desc (descending)
title: SortDirection
securitySchemes:
default:
type: http
scheme: bearer