> ## Documentation Index
> Fetch the complete documentation index at: https://help.teable.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Records

<Tip>We provide developers with a built-in [Query Parameter Builder](https://app.teable.ai/developer/tool/query-builder) that can help construct custom requests based on your existing tables.</Tip>

### Path

GET /api/table/\{tableId}/record
​

### Request

#### Path Parameters

tableId (string): The unique identifier of the table [(how to get)](/en/api-doc/get-id#tableid).

#### Basic Query Parameters

All parameters are optional

<ParamField query="viewId" type="string">
  Specifies the view ID to fetch records from. If not specified, records will be returned in order of creation time, including all records and fields.
</ParamField>

<ParamField query="take" type="number">
  Specifies the number of records to retrieve, maximum value is 1000.
</ParamField>

<ParamField query="skip" type="number">
  Specifies the number of records to skip, used for pagination.
</ParamField>

<ParamField query="fieldKeyType" type="string" default="name">
  Defines the key type for fields in records, possible values:

  * `name`: Use field names as keys (default)
  * `id`: Use field IDs as keys
  * `dbFieldName`: Use field dbFieldName as keys
</ParamField>

<ParamField query="cellFormat" type="string" default="json">
  Defines the return format for cell values, possible values:

  * `json`: Returns structured JSON data (default)
  * `text`: Returns plain text format
</ParamField>

<ParamField query="projection" type="string[]">
  If you only need specific fields, specify them through this parameter. Otherwise, all visible fields will be retrieved. Parameter values depend on fieldKeyType setting (using field names or IDs or dbFieldName).
</ParamField>

<ParamField query="orderBy" type="string">
  Array of sort objects specifying how records should be ordered.
</ParamField>

<ParamField query="filter" type="string">
  Complex query condition object for filtering results. Supports complex query conditions based on fields, operators, and values.
</ParamField>

<ParamField query="search" type="string[]">
  Search for records matching specified fields and values.
</ParamField>

<Accordion title="Advanced Query Parameters">
  <ParamField query="groupBy" type="string">
    Array of group objects specifying how records should be grouped.
  </ParamField>

  <ParamField query="collapsedGroupIds" type="string[]">
    Array of group IDs to collapse.
  </ParamField>

  <ParamField query="selectedRecordIds" type="string[]">
    Filter selected records by record IDs.
  </ParamField>

  <ParamField query="ignoreViewQuery" type="boolean">
    When viewId is specified, setting this to true will ignore the view's filters, sorting, and other settings.
  </ParamField>

  <ParamField query="filterLinkCellCandidate" type="string[]">
    Filter records from the linked table that can be selected by the specified link cell. For example, for one-to-many or one-to-one relationship fields, already selected record IDs will not appear.
  </ParamField>

  <ParamField query="filterLinkCellSelected" type="string[]">
    Filter records from the linked table that are already selected by this link cell. Note: viewId, filter, and orderBy will not take effect in this case, as selected records have their own order.
  </ParamField>
</Accordion>