---
title: "Search records"
method: POST
path: "/v2/objects/records/search"
tags: ["Records"]
---

# Search records

`POST /v2/objects/records/search`

The search records endpoint provides a convenient way to fuzzy search for records across one or more objects.
The matching strategy employed in this endpoint follows the in-product strategy and will match names, domains, emails, phone numbers and social handles on people and companies, and labels on all other objects.
Please note, results returned from this endpoint are eventually consistent. For results which are guaranteed to be up to date, please use the record query endpoint instead.

This endpoint is in beta. We will aim to avoid breaking changes, but small updates may be made as we roll out to more users.

Required scopes: `record_permission:read`, `object_configuration:read`.

## Request body

- object
  - `query` string, required — Query string to search for. An empty string returns a default set of results.
  - `limit` number — The maximum number of results to return. Defaults to 25.
  - `objects` string[], required — Specifies which objects to filter results by. At least one object must be specified. Accepts object slugs or IDs.
  - `request_as` union, required — Specifies the context in which to perform the search. Use 'workspace' to return all search results or specify a workspace member to limit results to what one specific person in your workspace can see.
    - object
      - `type` 'workspace', required
    - object
      - `type` 'workspace-member', required
      - `workspace_member_id` string, uuid, required
    - object
      - `type` 'workspace-member', required
      - `email_address` string, email, required

## Response `200`

Success

- object — Success
  - `data` union[], required
    - union
      - object
        - `id` object, required
          - `workspace_id` string, uuid, required — A UUID identifying the workspace this record belongs to.
          - `object_id` string, uuid, required — A UUID identifying the object this record belongs to.
          - `record_id` string, uuid, required — A UUID identifying this record.
        - `record_text` string, required — A human-readable label for the record. Present on records from all objects.
        - `record_image` string, nullable, required — The image for the record.
        - `object_slug` string, required — The slug of the object this record belongs to.
      - object
        - `id` object, required
          - `workspace_id` string, uuid, required — A UUID identifying the workspace this record belongs to.
          - `object_id` string, uuid, required — A UUID identifying the object this record belongs to.
          - `record_id` string, uuid, required — A UUID identifying this record.
        - `record_text` string, required — A human-readable label for the record. Present on records from all objects.
        - `record_image` string, nullable, required — The image for the record.
        - `object_slug` 'people', required — The slug of the object this record belongs to.
        - `email_addresses` string[], required — The person's email addresses.
        - `phone_numbers` string[], required — The person's phone numbers.
      - object
        - `id` object, required
          - `workspace_id` string, uuid, required — A UUID identifying the workspace this record belongs to.
          - `object_id` string, uuid, required — A UUID identifying the object this record belongs to.
          - `record_id` string, uuid, required — A UUID identifying this record.
        - `record_text` string, required — A human-readable label for the record. Present on records from all objects.
        - `record_image` string, nullable, required — The image for the record.
        - `object_slug` 'companies', required — The slug of the object this record belongs to.
        - `domains` string[], required — The company's domains.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/attio/apis/attio-api.md) · [All operations](https://skmtc.net/attio/apis/attio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/attio/attio-api/versions/40a8e41d06a2/schema)
