The identity and technical contract details declared by the specification.
type_jobs:JobOutcomeTriggerAudience
string
For whom the job outcome's next effect should be triggered automatically
type_records:CellConfig
object
CellConfig
1 property
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_records:ValidationType
string
type_data-clips:RemovedFromMainResolution
string
type_jobs:JobPartExecution
string
type_jobs:Driver
string
The driver to use for extracting data from the file
type_jobs:FlagMutationConfigData
object
Flag data for mutation operations
3 properties
1 required
type_jobs:JobType
string
The type of job
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_jobs:JobAckDetails
object
Details about the user who acknowledged the job
3 properties
type_commons:ActionMessage
object
2 properties
2 required
type_commons:EnvironmentId
string
Environment ID
type_property:StringConfig
object
1 property
1 required
type_jobs:JobOutcomeTriggerType
string
Whether a job outcome's effect should be triggered automatically
type_commons:ActionConstraint
type_jobs:PipelineJobConfig
object
3 properties
2 required
type_jobs:ExportJobConfig
object
1 property
1 required
type_jobs:JobPartsArray
array
Data for each of the job parts
type_jobs:JobExecutionPlan
object
The execution plan for a job, for example, for a map job, the execution plan is the mapping of the source sheet to the destination sheet.
4 properties
3 required
type_commons:InputEnumPropertyOption
object
6 properties
1 required
type_commons:Pagination
object
pagination info
3 properties
3 required
type_jobs:MutateJobConfig
object
11 properties
2 required
type_jobs:Edge
object
5 properties
2 required
type_commons:AppId
string
App ID
type_commons:SortDirection
string
Sort direction - asc (ascending) or desc (descending)
type_jobs:JobOutcomeTriggerDetails
object
Details about the trigger for the job outcome
2 properties
1 required
type_records:DiffRecord
object
9 properties
2 required
type_jobs:JobSubject
Subject parameters for this job type
type_records:RecordConfig
object
Configuration of a record or specific fields in the record
3 properties
type_records:CellValueUnion
type_data-clips:ResolveTo
string
type_jobs:JobOutcomeNextFileObject
object
2 properties
1 required
type_jobs:Metadata
object
4 properties
type_jobs:JobSource
string
The id of a file, workbook, sheet, or app
type_jobs:Certainty
string
type_jobs:AiGenerateBlueprintConstraintsJobConfig
object
2 properties
2 required
type_jobs:JobCancelDetails
object
Info about the reason the job was canceled
1 property
type_property:FieldSize
string
The default visual sizing. This sizing may be overridden by a user
type_commons:InputConstraintType
string
type_agent-exports:AgentExportType
string
The different export type formats available.
type_data-clips:Resolve
object
Conflict resolutions for a record
6 properties
type_jobs:JobCompleteDetails
object
Outcome summary of a job
2 properties
type_jobs:AiGenerateConstraintJobConfig
object
3 properties
2 required
type_commons:RecordId
string
Record ID
type_jobs:JobMode
string
the mode of the job
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_commons:ActionId
string
Action ID
type_jobs:EmptyObject
object
type_jobs:AiGenerateSampleDataJobConfig
object
2 properties
2 required
type_data-clips:ResolveType
string
type_jobs:DestinationField
object
2 properties
1 required
type_commons:InputField
object
7 properties
3 required
type_jobs:JobPlan
object
The job/plan tuple that contains the full plan and the jobs status
2 properties
2 required
type_jobs:JobConfig
object
A single unit of work that a pipeline will execute
23 properties
3 required
type_jobs:MappingFromPreprocessingJobConfig
object
2 properties
2 required
type_jobs:EnumDetails
object
Only available if one or more of the destination fields is of type enum. Provides category mapping.
3 properties
1 required
type_jobs:JobSplitDetails
object
Info about the reason the job was split
2 properties
1 required
type_jobs:JobParts
Info about the number of parts to create
type_commons:SpaceId
string
Space ID
type_jobs:AiGenerateBlueprintJobConfig
object
2 properties
2 required
type_commons:SortField
string
Name of field by which to sort records
type_jobs:JobDestination
The id of the workbook where extracted file data will be sent
type_jobs:JobExecutionPlanRequest
object
6 properties
5 required
type_jobs:JobExecutionPlanConfigRequest
object
6 properties
2 required
type_jobs:BulkMutateFlagsJobConfig
object
The configuration for a bulk flag mutation job
11 properties
2 required
type_commons:DataClipId
string
Data Clip ID
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_commons:CommitId
string
Commit ID
type_property:EnumPropertyOption
object
8 properties
1 required
type_commons:Guide
object
1 property
1 required
type_jobs:JobOutcome
object
Outcome summary of a job
7 properties
type_jobs:AiRuleCreationJobConfig
object
Configuration for AI-powered rule creation jobs that generate or replace field constraints
5 properties
3 required
type_jobs:CompanyResearchJobConfig
object
The configuration for a company research job
3 properties
1 required
type_jobs:ListJobsResponse
object
2 properties
1 required
type_property:NumberConfig
object
1 property
type_jobs:Job
object
A single unit of work that will execute asynchronously
31 properties
7 required
type_property:RequiredConstraintConfig
object
2 properties
type_commons:FileId
string
File ID
type_commons:ActionMessageType
string
type_jobs:ConfigureDemoJobConfig
object
The configuration for an onboarding job
1 property
1 required
type_commons:SheetId
string
Sheet ID
type_jobs:AddRecordsToDataClipJobConfig
object
The configuration for an add records to DataClip job
2 properties
2 required
type_jobs:RunRunbookJobConfig
object
2 properties
2 required
type_commons:RunbookId
string
Runbook ID
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property
1 required
type_commons:JobId
string
Pipeline Job ID
type_flags:FlagOperation
string
The type of flag operation to perform
type_commons:SearchField
string
Use this to narrow the searchValue results to a specific field
type_jobs:DeleteRecordsJobConfig
object
The configuration for a delete job
8 properties
1 required
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:ActorId
string
Actor ID
type_commons:FilterField
string
Use this to narrow the valid/error filter results to a specific field
type_jobs:FindAndReplaceJobConfig
object
10 properties
1 required
type_jobs:UpdateDataClipResolutionsJobConfig
object
Configuration for a data clip resolution job
6 properties
6 required
type_jobs:ExportOptions
object
10 properties
type_property:StoredConstraint
object
5 properties
1 required
type_jobs:Trigger
string
The type of trigger to use for this job
type_jobs:JobStatus
string
the status of the job
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_property:StringConfigOptions
string
How much text should be storeable in this field
type_property:UniqueConstraintConfig
object
4 properties
type_records:DiffData
object
type_records:DiffValue
object
10 properties
type_commons:InputConstraint
object
1 property
1 required
type_jobs:AgentExportJobConfig
object
The configuration for an agent export job
1 property
1 required
type_commons:InputForm
object
2 properties
2 required
type_jobs:CategoryMapping
object
2 properties
type_jobs:JobPlanResponse
object
1 property
1 required
type_jobs:MappingProgramJobConfig
object
4 properties
3 required
type_commons:SuccessData
object
1 property
1 required
type_jobs:CaptureRoutineJobConfig
object
2 properties
2 required
type_jobs:JobUpdate
object
A single unit of work that will be executed
6 properties
type_jobs:AgentPromotionJobConfig
object
The configuration for an agent promotion job
2 properties
2 required
type_jobs:FileJobConfig
object
3 properties
1 required
type_jobs:FlagMutationConfig
object
Configuration for flag mutation operations
4 properties
3 required
type_property:EnumPropertyConfig
object
3 properties
1 required
type_jobs:SourceField
object
2 properties
1 required
type_property:ReferencePropertyConfig
object
4 properties
2 required
type_records:DiffRecords
array
List of DiffRecord objects
type_commons:Guardrail
object
1 property
1 required
type_records:ValidationMessage
object
Record data validation messages
5 properties
type_jobs:JobResponse
object
1 property
1 required
type_jobs:JobUpdateConfig
type_jobs:JobOutcomeTrigger
type_records:DiffRecordsResponse
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Flatfile publishes across the network.
