---
title: "Get records"
method: GET
path: "/sheets/{sheetId}/records"
tags: ["records"]
---

# Get records

`GET /sheets/{sheetId}/records`

Returns records from a sheet in a workbook

## Path parameters

- `sheetId` string, required — Sheet ID

## Query parameters

- `versionId` string — Version ID
- `commitId` string — Commit ID
- `sinceVersionId` string — Version ID
- `sinceCommitId` string — Commit ID
- `sortField` string — Name of field by which to sort records
- `sortDirection` 'asc' | 'desc' — Sort direction - asc (ascending) or desc (descending)
- `filter` 'valid' | 'error' | 'all' | 'none' — Options to filter records
- `filterField` string — Use this to narrow the valid/error filter results to a specific field
- `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 quotes ("")
- `searchField` string — Use this to narrow the searchValue results to a specific field
- `ids` string — Record ID
- `pageSize` integer
- `pageNumber` integer
- `includeCounts` boolean
- `includeLength` boolean
- `includeLinks` boolean
- `includeMessages` boolean
- `fields` string
- `for` string — Event ID
- `q` string

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Response `200`

Response with status 200

- TypeRecordsGetRecordsResponse
  - `data` TypeRecordsGetRecordsResponseData, required — A list of records with optional record counts
    - `success` boolean, required
    - `records` TypeRecordsRecordWithLinks[], required — List of Record objects, including links to related rows
      - `id` string, required — Record ID
      - `values` TypeRecordsRecordDataWithLinks, required — A single row of data in a Sheet, including links to related rows
      - `valid` boolean
      - `messages` TypeRecordsValidationMessage[]
        - `field` string
        - `type` 'error' | 'warn' | 'info'
        - `source` 'required-constraint' | 'unique-constraint' | 'custom-logic' | 'unlinked' | 'invalid-option' | 'is-artifact'
        - `message` string
        - `path` string — A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535
      - `metadata` object
      - `config` TypeRecordsRecordConfig — Configuration of a record or specific fields in the record
        - `readonly` boolean
        - `fields` object
        - `markedForDeletion` boolean
    - `counts` 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
    - `versionId` string — Version ID
    - `commitId` string — Commit ID

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[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/revisions/9d3a9979cd96/schema)