---
title: "Search clients"
method: GET
path: "/clients/search"
tags: ["Clients"]
---

# Search clients

`GET /clients/search`

Full-text search across clients using Typesense. Provides fast, typo-tolerant search capabilities.

**gigstack Connect:** Access other teams' clients using the `team` parameter.

**Search Capabilities:**
- Search across client name, email, tax ID, legal name, and metadata
- Typo-tolerant fuzzy matching
- Paginated results

**Requirements:**
- Typesense must be configured for your team
- The `q` (or `query`) parameter is required

## Query parameters

- `team` string
- `q` string, required
- `query` string
- `limit` integer
- `page` integer
- `fields` string[]

## Response `200`

Clients searched successfully

- object
  - `message` string, required
  - `data` ApiPublicClient[], required
    - `id` string, required — Unique client identifier
    - `address` ClientAddress, nullable
      - `country` string, nullable
      - `street` string, nullable
      - `zip` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `exterior` string, nullable
      - `interior` string, nullable
      - `municipality` string, nullable
      - `neighborhood` string, nullable
    - `name` string, nullable — Client name
    - `company` string, nullable — Client company name
    - `phone` string, nullable — Client phone number
    - `email` string, email, nullable, required — Client email address
    - `bcc` string[], nullable — BCC email addresses for client communications
    - `metadata` object, nullable — Additional metadata for the client
    - `is_valid` boolean, nullable — Whether the client data is valid
    - `from` string, required — Source of client creation
    - `legal_name` string, nullable — Legal name for tax purposes
    - `livemode` boolean, required — Whether this client is in live mode
    - `owner` string, required — User ID who owns this client
    - `tax_id` string, nullable — RFC (Tax ID) for Mexican tax compliance
    - `use` string, nullable — CFDI use code
    - `tax_system` string, nullable — SAT tax system code
    - `team` string, required — Team ID this client belongs to
    - `created_at` number, required — Unix timestamp of client creation
    - `efos` object, nullable — EFOS (SAT blacklist) validation status
      - `is_valid` boolean, nullable — Whether the client is valid according to SAT EFOS list
    - `defaults` object, nullable — Client default settings
      - `keep_full_legal_name` boolean, nullable — Keep full legal name in documents
      - `issue_automatic_invoices` boolean, nullable — Issue automatic invoices
      - `issue_invoiceable_receipts` boolean, nullable — Issue invoiceable receipts
  - `found` integer, required — Total number of results found
  - `page` integer, required — Current page number
  - `per_page` integer, required — Number of results per page
  - `success` boolean, required
  - `timestamp` number, required — Unix timestamp in milliseconds

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal server error

---

[API](https://skmtc.dev/disruptive-learning/apis/gigstack-api-v2.md) · [All operations](https://skmtc.dev/disruptive-learning/apis/gigstack-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/disruptive-learning/gigstack-api-v2/revisions/5cf53ffd7580/schema)