Flatfile subpackage_sheets API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes
13 operations
across 11 paths,
and defines 82 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.x.flatfile.com/v1.
The identity and technical contract details declared by the specification.
type_property:FieldAppearance
object
Control the appearance of this field when it's displayed in a table or input
1 property
type_records:ValidationSource
string
type_sheets:CellsResponseData
object
Cell values grouped by field key
type_records:ValidationType
string
type_commits:Commit
object
A commit version
6 properties
4 required
type_property:ReferenceFilter
object
If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the val…
2 properties
2 required
type_commons:Filter
string
Options to filter records
type_commons:ActionMessage
object
2 properties
2 required
type_property:StringConfig
object
1 property
1 required
type_sheets:RecordCountsResponseData
object
2 properties
2 required
type_sheets:Distinct
boolean
When true, excludes duplicate values
type_commons:ActionConstraint
type_commons:InputEnumPropertyOption
object
6 properties
1 required
type_commits:ListCommitsResponse
object
1 property
1 required
type_commons:SortDirection
string
Sort direction - asc (ascending) or desc (descending)
type_records:CellValueUnion
type_sheets:CellValueWithCounts
object
7 properties
type_sheets:SheetConfig
object
Describes shape of data as well as behavior
13 properties
2 required
type_commons:PageSize
integer
Number of logs to return in a page (default 20)
type_property:FieldSize
string
The default visual sizing. This sizing may be overridden by a user
type_commons:InputConstraintType
string
type_sheets:FieldKey
string
Returns results from the given field only. Otherwise all field cells are returned
type_commons:RecordId
string
Record ID
type_commons:SearchValue
string
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 q…
type_sheets:CompositeUniqueConstraintStrategy
string
type_sheets:Sheet
object
A place to store tabular data
16 properties
7 required
type_commons:ActionId
string
Action ID
type_commons:PageNumber
integer
Based on pageSize, which page of records to return
type_commons:InputField
object
7 properties
3 required
type_sheets:SheetResponse
object
1 property
1 required
type_commons:SortField
string
Name of field by which to sort records
type_records:FieldRecordCounts
object
4 properties
4 required
type_records:RecordCounts
object
5 properties
3 required
type_sheets:CellsResponse
object
1 property
1 required
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_commons:CommitId
string
Commit ID
type_sheets:ListSheetsResponse
object
1 property
1 required
type_property:EnumPropertyOption
object
8 properties
1 required
type_commons:Guide
object
1 property
1 required
type_property:NumberConfig
object
1 property
type_property:RequiredConstraintConfig
object
2 properties
type_sheets:SheetConstraint
type_commons:ActionMessageType
string
type_commons:SheetId
string
Sheet ID
type_commons:CalculationId
string
Calculation ID
type_commons:Error
object
2 properties
1 required
type_sheets:SheetUpdateRequest
object
Changes to make to an existing sheet
3 properties
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property
1 required
type_commons:SearchField
string
Use this to narrow the searchValue results to a specific field
type_property:BooleanPropertyConfig
object
1 property
1 required
type_commons:Action
object
25 properties
1 required
type_property:ReferencePropertyRelationship
string
type_commons:JSONPathString
string
A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535
type_property:EnumPropertySortBy
string
type_property:ReferenceListPropertyConfig
object
3 properties
2 required
type_commons:VersionId
string
Version ID
type_commons:FilterField
string
Use this to narrow the valid/error filter results to a specific field
type_sheets:IncludeCounts
boolean
When both distinct and includeCounts are true, the count of distinct field values will be returned
type_commons:ActionMode
string
Foreground actions will prevent interacting with the resource until complete
type_commons:WorkbookId
string
Workbook ID
type_commons:ActionSchedule
string
type_sheets:SheetAccess
string
type_property:StringConfigOptions
string
How much text should be storeable in this field
type_property:UniqueConstraintConfig
object
4 properties
type_commons:InputConstraint
object
1 property
1 required
type_commons:InputForm
object
2 properties
2 required
type_sheets:Calculation
object
6 properties
5 required
type_commons:SuccessData
object
1 property
1 required
type_property:EnumPropertyConfig
object
3 properties
1 required
type_commons:Errors
object
1 property
1 required
type_sheets:SheetTreatments
string
type_sheets:CalculationType
string
type_property:ReferencePropertyConfig
object
4 properties
2 required
type_sheets:CompositeUniqueConstraintConfig
object
2 properties
type_commons:Guardrail
object
1 property
1 required
type_records:ValidationMessage
object
Record data validation messages
5 properties
type_sheets:ListCalculationsResponse
object
1 property
1 required
type_sheets:RecordCountsResponse
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Flatfile publishes across the network.
