curl --request GET \
--url https://api.gigstack.io/v2/clients/search \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/clients/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/clients/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "Clients searched successfully",
"data": [
{
"id": "client_1234567890",
"name": "ESCUELA KEMPER URGATE",
"legal_name": "ESCUELA KEMPER URGATE",
"email": "contabilidad@ejemplo.com",
"bcc": [],
"phone": "+524421234567",
"tax_id": "EKU9003173C9",
"tax_system": "601",
"use": "G03",
"address": {
"street": "Av. Constituyentes",
"exterior": "1000",
"neighborhood": "Centro",
"city": "Querétaro",
"state": "QRO",
"zip": "76000",
"country": "MEX"
},
"is_valid": true,
"efos": {
"is_valid": true
},
"metadata": {},
"livemode": true,
"from": "api",
"owner": "user_1234567890",
"team": "team_1234567890",
"created_at": 1767225600000
}
],
"found": 1,
"page": 1,
"per_page": 10,
"timestamp": 1767225600000
}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(orquery) parameter is required
curl --request GET \
--url https://api.gigstack.io/v2/clients/search \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/clients/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/clients/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "Clients searched successfully",
"data": [
{
"id": "client_1234567890",
"name": "ESCUELA KEMPER URGATE",
"legal_name": "ESCUELA KEMPER URGATE",
"email": "contabilidad@ejemplo.com",
"bcc": [],
"phone": "+524421234567",
"tax_id": "EKU9003173C9",
"tax_system": "601",
"use": "G03",
"address": {
"street": "Av. Constituyentes",
"exterior": "1000",
"neighborhood": "Centro",
"city": "Querétaro",
"state": "QRO",
"zip": "76000",
"country": "MEX"
},
"is_valid": true,
"efos": {
"is_valid": true
},
"metadata": {},
"livemode": true,
"from": "api",
"owner": "user_1234567890",
"team": "team_1234567890",
"created_at": 1767225600000
}
],
"found": 1,
"page": 1,
"per_page": 10,
"timestamp": 1767225600000
}Authorizations
Authentication Method: HTTP Bearer token.
The runtime requires the literal Bearer prefix — a bare token in the
Authorization header is rejected with 401 unauthorized.
Header Format: Authorization: Bearer YOUR_API_KEY
Your API key is a JWT. Live keys operate on live data (livemode: true);
test keys operate on isolated test data (livemode: false).
Get your key at: app.gigstack.pro/settings?tab=api
Errors: credential failures are answered by the authentication layer with a raw
{ "message": … } body, not the standardized envelope — 401 for a missing, malformed or
expired token, 403 for a revoked key or a plan without API access. See the Unauthorized
and AuthForbidden responses.
Query Parameters
gigstack Connect: Target team ID for multi-team access.
Requires gigstack Connect enabled on your team and shared billing account.
Also requires the multipleIssuerAccounts feature on your plan. Requests targeting a
team other than the one your API key belongs to return 403 without it.
Only API keys can use it: an OAuth access token sent with another team's id is rejected with
403 Team mismatch with OAuth token.
Optional — omit it entirely unless you are acting on another team. It deliberately
carries no example value so generated snippets do not emit ?team=undefined; when the
parameter is absent, the team is derived from your API key.
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 10, max 100)
1 <= x <= 100Page number for pagination (default 1)
x >= 1Comma-separated list of fields to include in the response
Response
Clients searched successfully
Response shape of the Typesense-backed /search endpoints (clients, invoices, payments,
receipts). Distinct from ListResponse: it reports found (total matches) rather than
has_more/total_results, and it has no cursor. It is also not the standardized
envelope — data is top-level.
These endpoints require both a q (or query) parameter and a Typesense key configured
on the team; either missing yields 400 with missing_query / missing_typesense_key.
true true
"Items searched successfully"
Total number of matching documents.
15
1
10
Server time in epoch milliseconds.
1767225600000