Search clients
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
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Example: ?team=team_xyz789
Search query text (primary parameter). Searches across relevant fields depending on the collection (e.g., client name, email, payment ID, description, metadata). The query parameter is also accepted as a backward-compatible alternative.
Alternative to q, kept for backward compatibility. If both are provided, q takes precedence.
Maximum number of items to return (default 50, max 100)
Page number for pagination (default 1)
Comma-separated list of fields to include in the response
Response
Clients searched successfully
Example response
{
"message": "Clients searched successfully",
"data": [
{
"id": "client_1234567890",
"address": {
"country": "MEX",
"street": "Av. Insurgentes Sur",
"zip": "03100",
"city": "Ciudad de México",
"state": "CDMX",
"exterior": "123",
"interior": "4B",
"municipality": "Benito Juárez",
"neighborhood": "Del Valle"
},
"name": "Juan Pérez García",
"company": "Empresa SA de CV",
"phone": "+52 55 1234 5678",
"email": "juan.perez@ejemplo.com",
"bcc": [
"admin@empresa.com"
],
"metadata": {
"custom_field": "value"
},
"is_valid": true,
"from": "api",
"legal_name": "Juan Pérez García",
"livemode": true,
"owner": "user_1234567890",
"tax_id": "PEGJ800101ABC",
"use": "P01",
"tax_system": "601",
"team": "team_1234567890",
"created_at": 1677651234,
"efos": {
"is_valid": true
},
"defaults": {
"issue_invoiceable_receipts": true
}
}
],
"found": 15,
"page": 1,
"per_page": 10,
"success": true,
"timestamp": 1677651234000
}