---
title: "Filter records by field text"
method: GET
path: "/api/v1/records/search"
tags: ["Records"]
---

# Filter records by field text

`GET /api/v1/records/search`

## Request

- Base URL: `https://api-docs.busabase.com`
- URL: `https://api-docs.busabase.com/api/v1/records/search`
- Auth: none declared

## Query parameters

- `baseId` string: Restrict to one Base. Omitting it searches the whole space.
- `fieldSlug` string, required: The field's SLUG, not its display name — visible in the Base's field settings.
- `valueText` string, required: Matched by EXACT equality, not substring or fuzzy — this is the de-dup-by-key lookup. Use `/api/v1/search` for full-text.
- `limit` integer: Maximum matches to return. Capped at 100.

## Response `200`

Canonical records matching a field text filter.

- object[]
  - `id` string, required
  - `baseId` string, required
  - `headCommitId` string, required
  - `parentRecordId` string, required
  - `parentCommitId` string, required
  - `status` 'active' | 'archived', required
  - `createdBy` string, required
  - `createdByUser` object
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `image` string, required
    - `role` string
  - `fieldUsers` object
  - `archivedAt` string, required
  - `createdAt` string, required
  - `updatedAt` string, required
  - `base` object, required
    - `id` string, required
    - `nodeId` string, required
    - `slug` string, required
    - `name` string, required
    - `description` string, required
    - `reviewPolicy` object, required
      - `kind` unknown, required
      - `requiredApprovals` number, required
    - `createdAt` string, required
    - `fields` object[], required
      - `id` string, required
      - `baseId` string, required
      - `slug` string, required
      - `name` union, required
        - string
        - object
      - `type` 'text' | 'longtext' | 'markdown' | 'html' | 'attachment' | 'relation' | 'member' | 'number' | 'date' | 'checkbox' | 'select' | 'multiselect' | 'url' | 'embed' | 'email' | 'phone' | 'created_time' | 'updated_time' | 'created_by' | 'updated_by' | 'auto_number' | 'ai_summary' | 'ai_tags' | 'code' | 'json' | 'yaml' | 'formula' | 'lookup' | 'whiteboard', required
      - `required` boolean, required
      - `position` number, required
      - `options` object
        - `help` object
          - `description` string
          - `example` string
        - `ai` object
          - `model` string
          - `prompt` string
          - `reviewRequired` boolean
          - `sourceFieldIds` string[]
        - `attachment` object
          - `allowedMimeTypes` string[]
        - `choices` object[]
          - `color` string
          - `id` string, required
          - `name` string, required
        - `code` object
          - `language` string
        - `date` object
          - `includeTime` boolean
          - `timezone` string: IANA time zone, e.g. "Asia/Shanghai". Omit to show each reader their own local time.
        - `embed` object
          - `aspectRatio` '16:9' | '4:3' | '1:1'
          - `providers` string[]
        - `formula` object
          - `expression` string, required
          - `format` 'auto' | 'number' | 'currency' | 'percent' | 'date'
          - `precision` integer
          - `currency` string
        - `inverseFieldId` string
        - `lookup` object
          - `relationFieldSlug` string, required: Slug of a `relation` field on THIS Base — the hop to follow.
          - `targetFieldSlug` string, required: Slug of the field on the related Base whose values are pulled over.
          - `rollup` 'values' | 'count' | 'sum' | 'average' | 'min' | 'max' | 'concatenate'
          - `limit` 'all' | 'first': `first` looks at only the first linked record; default `all`.
        - `multiple` boolean
        - `number` object
          - `format` 'plain' | 'currency'
          - `currency` string
          - `locale` string
        - `targetBaseId` string: Relation target Base id (bse_…). Or pass targetBaseSlug to name it by slug.
        - `targetBaseSlug` string: Relation target Base by slug — a convenience alias for targetBaseId, resolved server-side (active bases in the current space). If both are given, targetBaseId wins.
  - `headCommit` object, required
    - `id` string, required
    - `baseId` string, required
    - `targetType` 'base' | 'node', required
    - `nodeId` string, required
    - `operationId` string, required
    - `parentCommitId` string, required
    - `payload` object, required
    - `operation` 'node_create' | 'node_rename' | 'node_delete' | 'node_restore' | 'node_move' | 'record_create' | 'record_update' | 'record_delete' | 'record_variant' | 'view_create' | 'view_update' | 'view_delete' | 'view_restore' | 'base_add_field' | 'base_delete_field' | 'base_update_field' | 'base_convert_field' | 'base_reorder_fields' | 'base_restore_field' | 'base_archive' | 'base_restore' | 'record_restore' | 'skill_file_create' | 'skill_file_update' | 'skill_file_delete' | 'skill_metadata_update' | 'drive_file_create' | 'drive_file_update' | 'drive_file_delete' | 'drive_metadata_update' | 'airapp_file_create' | 'airapp_file_update' | 'airapp_file_delete' | 'airapp_metadata_update' | 'doc_update' | 'whiteboard_document_update' | 'workflow_document_update' | 'html_document_update', required
    - `message` string, required
    - `author` string, required
    - `authorUser` object
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `image` string, required
      - `role` string
    - `createdAt` string, required

---

[API](https://skmtc.dev/busabase/apis/busabase-api.md) · [All operations](https://skmtc.dev/busabase/apis/busabase-api/llms.txt) · [OpenAPI document](https://skmtc.dev/busabase/apis/busabase-api/revisions/bc6a7d5ff4c1?raw)