--- title: "Get a sheet" method: GET path: "/sheets/{sheetId}" tags: ["sheets"] --- # Get a sheet `GET /sheets/{sheetId}` Returns a sheet in a workbook ## Path parameters - `sheetId` string, required — Sheet ID ## Headers - `Authorization` string, required - `X-Disable-Hooks` 'true', required ## Response `200` Response with status 200 - TypeSheetsSheetResponse - `data` TypeSheetsSheet, required — A place to store tabular data - `id` string, required — Sheet ID - `workbookId` string, required — Workbook ID - `name` string, required — The name of the Sheet. - `slug` string, required — The slug of the Sheet. - `config` TypeSheetsSheetConfig, required — Describes shape of data as well as behavior - `name` string, required — The name of your Sheet as it will appear to your end users. - `description` string — A sentence or two describing the purpose of your Sheet. - `slug` string — A unique identifier for your Sheet. - `readonly` boolean — A boolean specifying whether or not this sheet is read only. Read only sheets are not editable by end users. - `allowAdditionalFields` boolean — Allow end users to add fields during mapping. - `mappingConfidenceThreshold` number, double — The minimum confidence required to automatically map a field - `access` TypeSheetsSheetAccess[] — Control Sheet-level access for all users. - `fields` TypePropertyProperty[], required — Where you define your Sheet's data schema. - union - object - `type` 'string', required — Discriminator value: string - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyStringConfig - … - object - `type` 'number', required — Discriminator value: number - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyNumberConfig - … - object - `type` 'boolean', required — Discriminator value: boolean - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyBooleanPropertyConfig - … - object - `type` 'date', required — Discriminator value: date - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum', required — Discriminator value: enum - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `multi` boolean — Will allow multiple values and store / provide the values in an array if set. Not all field types support arrays. Use enum-list type instead. - `config` TypePropertyEnumPropertyConfig, required - … - object - `type` 'reference', required — Discriminator value: reference - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferencePropertyConfig, required - … - object - `type` 'reference-list', required — Discriminator value: reference-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `isArray` boolean — Will allow multiple values and store as an array. Use enum-list type instead. - `config` TypePropertyReferenceListPropertyConfig, required - … - object - `type` 'string-list', required — Discriminator value: string-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - object - `type` 'enum-list', required — Discriminator value: enum-list - `key` string, required - `label` string — User friendly field name - `description` string — A short description of the field. Markdown syntax is supported. - `constraints` TypePropertyConstraint[] — A list of constraints that should be applied to this field. This is limited to a maximum of 10 constraints and all external and stored constraints must have unique validator values. - … - `readonly` boolean - `appearance` TypePropertyFieldAppearance — Control the appearance of this field when it's displayed in a table or input - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Column. - … - `metadata` unknown - `treatments` string[] — A unique presentation for a field in the UI. - `alternativeNames` string[] - `config` TypePropertyEnumPropertyConfig, required - … - `actions` TypeCommonsAction[] — An array of actions that end users can perform on this Sheet. - `slug` string — **This is deprecated. Use `operation` instead.** - `operation` string — This will become the job operation that is triggered - `mode` 'foreground' | 'background' | 'toolbarBlocking' — Foreground actions will prevent interacting with the resource until complete - `tooltip` string — A tooltip that appears when hovering the action button - `messages` TypeCommonsActionMessage[] - `type` 'error' | 'info', required - `content` string, required - `type` string — **This is deprecated.** - `description` string — The text that appears in the dialog after the action is clicked. - `schedule` 'weekly' | 'daily' | 'hourly' - `primary` boolean — A primary action will be more visibly present, whether in Sheet or Workbook. - `confirm` boolean — Whether to show a modal to confirm the action - `icon` string — Icon will work on primary actions. It will only accept an already existing Flatfile design system icon. - `requireAllValid` boolean — **This is deprecated. Use `constraints` instead.** - `requireSelection` boolean — **This is deprecated. Use `constraints` instead.** - `inputForm` TypeCommonsInputForm - `type` 'simple', required - `fields` TypeCommonsInputField[], required - `key` string, required — Unique key for a Field. - `label` string, required — Visible name of a Field. - `description` string — Brief description below the name of the Field. - `type` string, required — Field Types inform the user interface how to sort and display data. - `defaultValue` unknown - `config` TypeCommonsInputConfig - … - `constraints` TypeCommonsInputConstraint[] — Indicate additional validations that will be applied to the Field. - … - `constraints` TypeCommonsActionConstraint[] — A limitation or restriction on the action. - union - object - … - object - … - object - … - object - … - `mount` union - object - `type` 'sheet', required — Discriminator value: sheet - `slugs` string[] - object - `type` 'workbook', required — Discriminator value: workbook - `slugs` string[] - object - `type` 'field', required — Discriminator value: field - `keys` string[] - object - `type` 'document', required — Discriminator value: document - object - `type` 'file', required — Discriminator value: file - `guide` TypeCommonsGuide - `content` string, required — Markdown guidance for this action - `guardrail` TypeCommonsGuardrail - `content` string, required — Markdown guardrail for this action - `createdFrom` string — Action ID - `lastPropagatedAt` string, date-time — The last time this action was propagated to a workbook - `deletedAt` string, date-time — The time this action was deleted - `invalidConditionalMessaging` boolean — When enabled, shows dynamic confirmation messages based on record validation status instead of the static description - `validRecordsMessage` string — Custom message to show when all records are valid (only used when invalidConditionalMessaging is true) - `invalidRecordsMessage` string — Custom message to show when there are invalid records (only used when invalidConditionalMessaging is true) - `label` string, required — The text on the Button itself - `metadata` unknown - `constraints` TypeSheetsSheetConstraint[] — An array of constraints that end users can perform on this Sheet. - union - object - `type` 'unique', required — Discriminator value: unique - `name` string, required — The name of the constraint - `fields` string[], required — The fields that must be unique together - `requiredFields` string[] — Fields that, when empty, will cause this unique constraint to be ignored - `strategy` 'hash' | 'concat', required - `config` TypeSheetsCompositeUniqueConstraintConfig - … - object - `type` 'external', required — Discriminator value: external - `validator` string, required - `fields` string[] — The fields that must be unique together - `config` unknown - `treatments` TypeSheetsSheetTreatments[] — An array of treatments that define the behavior of the sheet. - `collection` string — Collection in which to group the sheet - `metadata` unknown - `namespace` string — The scoped namespace of the Sheet. - `lockedBy` string — The actor who locked the Sheet. - `updatedAt` string, date-time, required — Date the sheet was last updated - `createdAt` string, date-time, required — Date the sheet was created - `lockedAt` string, date-time — The time the Sheet was locked. - `recordCounts` TypeRecordsRecordCounts - `total` integer, required - `valid` integer, required - `error` integer, required - `errorsByField` object - `byField` object — Counts for valid, error, and total records grouped by field key - `createdFrom` string — Sheet ID - `lastPropagatedAt` string, date-time — The last time the sheet template configuration was propagated to this sheet - `treatments` TypeSheetsSheetTreatments[] — An array of treatments that define the behavior of the sheet. - `collection` string — Collection in which to group the sheet --- [API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/versions/9d3a9979cd96/schema)