curl --request GET \
--url https://api.gigstack.io/v2/clients \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/clients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"message": "Clients retrieved successfully",
"data": [
{
"id": "client_1234567890",
"name": "Juan Pérez García",
"email": "juan.perez@ejemplo.com",
"tax_id": "PEGJ800101ABC",
"tax_system": "601",
"legal_name": "Juan Pérez García",
"address": {
"street": "Av. Insurgentes Sur 123",
"zip": "03100",
"city": "Ciudad de México",
"state": "CDMX",
"country": "MEX"
},
"is_valid": true,
"livemode": true,
"created_at": 1677651234,
"team": "team_1234567890",
"owner": "user_1234567890",
"from": "api"
}
],
"has_more": false,
"total_results": 1
}List clients
Retrieve a paginated list of clients with powerful filtering capabilities.
gigstack Connect: Access other teams’ clients using the team parameter.
Filtering Options:
- Filter by creation date using comparison operators
- Filter by metadata fields using dot or underscore notation (e.g.,
metadata.external_idormetadata_external_id)
curl --request GET \
--url https://api.gigstack.io/v2/clients \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gigstack.io/v2/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.gigstack.io/v2/clients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"message": "Clients retrieved successfully",
"data": [
{
"id": "client_1234567890",
"name": "Juan Pérez García",
"email": "juan.perez@ejemplo.com",
"tax_id": "PEGJ800101ABC",
"tax_system": "601",
"legal_name": "Juan Pérez García",
"address": {
"street": "Av. Insurgentes Sur 123",
"zip": "03100",
"city": "Ciudad de México",
"state": "CDMX",
"country": "MEX"
},
"is_valid": true,
"livemode": true,
"created_at": 1677651234,
"team": "team_1234567890",
"owner": "user_1234567890",
"from": "api"
}
],
"has_more": false,
"total_results": 1
}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
Maximum number of items to return (default 10, max 100)
1 <= x <= 100Pagination cursor for the next page of results
Field name to order results by
name, timestamp Sort direction for the results Sort direction for list queries
asc, desc Filter results created on or after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).
Filter results created on or before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).
Filter results created after this timestamp. Accepts Unix timestamp in seconds (e.g., 1733011200), milliseconds (e.g., 1733011200000), or ISO 8601 date string (e.g., 2024-12-01).
Filter results created before this timestamp. Accepts Unix timestamp in seconds (e.g., 1735689599), milliseconds (e.g., 1735689599000), or ISO 8601 date string (e.g., 2024-12-31).
Filter results by the client's tax ID / RFC (e.g., PEGJ800101ABC)
Filter by any metadata field using dot notation (e.g., metadata.external_id=EXT-123)
or underscore notation (e.g., metadata_external_id=EXT-123).
Both formats are supported and equivalent.
Uses Typesense search for efficient querying without requiring Firestore indexes.
Page number for pagination when using metadata filters (default 1). Only applies when filtering by metadata fields.
x >= 1