gigstack API
  1. Clients
gigstack API
  • Welcome to gigstack API
  • gigstack Connect API Guide
  • Migrar de API v1 a v2 de gigstack
  • Clients
    • Clients API Guide
    • List clients
      GET
    • Get client
      GET
    • Update client
      PUT
    • Create client
      POST
    • Validate client fiscal information
      POST
    • Get client customer portal access token
      POST
    • Stamp pending receipts
      POST
    • Delete client
      DELETE
    • Search clients
      GET
    • Upload CSF PDF to create or update client
      POST
    • Upload support document
      POST
    • List support documents
      GET
  • Services
    • Services API Guide
    • List services
      GET
    • Get service
      GET
    • Update service
      PUT
    • Create service
      POST
    • Delete service
      DELETE
  • Invoices
    • Invoices API Guide
    • Income
      • List income invoices
      • Create income invoice
      • Get income invoice
    • Egress
      • List egress invoices
      • Create egress invoice
      • Get egress invoice
    • List CFDI errors
      GET
    • List payment complement invoices
      GET
    • Get payment complement invoice
      GET
    • Get invoice files
      GET
    • Upload support document
      POST
    • List support documents
      GET
    • Cancel invoice
      DELETE
    • Search invoices
      GET
  • Payments
    • Payments API Guide
    • List payments
    • Get payment
    • Request payment
    • Register payment
    • Mark payment as paid
    • Refund payment
    • Cancel payment
    • Search payments
    • Upload support document
    • List support documents
  • Receipts
    • Receipts API Guide
    • List receipts
    • Get receipt
    • Create receipt
    • Stamp receipt
    • Cancel receipt
    • Search receipts
  • Teams
    • Teams API Guide
    • List teams
    • Get team
    • Get team integrations
    • Get team series
    • Get team onboarding URL
    • Update team
    • Update team series
    • Update team settings
    • Create team
    • Add team member
    • Remove team member
    • Create team series
    • Upload SAT CSD certificates
    • Sign manifest document
  • Users
    • Users API Guide
    • List users
    • Get user
    • Update user
    • Create user
    • Reset user password
    • Generate login link
  • Catalogs
    • Tax Regimes Catalog (Régimen Fiscal)
    • Payment Forms | Formas de pago
    • CFDI Usage Catalog (Uso CFDI)
    • Payment Methods Catalog (Método de Pago)
    • Months and Bimesters Catalog (Meses y Bimestres)
    • Invoice Relationships Catalog (Relación entre Facturas)
  • Webhooks
    • Webhooks
    • List webhooks
    • Create webhook
    • Get webhook
    • Update webhook
    • Delete webhook
  • Retentions
    • List retentions
    • Create retention
    • Get retention
    • Cancel retention
    • Get retention files
  • Apidog connectivity test
    GET
  • Schemas
    • Schemas
      • ApiResponse
      • Category
      • Pet
      • Tag
      • Order
      • StandardizedSuccessResponse
      • StandardizedErrorResponse
      • ApiErrorCode
    • RequestBodies
      • UserArray
    • ApiPublicClient
    • Client
    • OrderDirection
    • Service
    • DateRangeFilter
    • ApiPublicService
    • ListQueryParams
    • ClientInput
    • ServiceInput
    • PaginationMeta
    • Invoice
    • InvoiceIncomeInput
    • Payment
    • PaymentInput
    • Team
    • InvoiceEgressInput
    • InvoiceInput
    • PaymentItem
    • PaymentAllowedMethod
    • TeamInput
    • TeamSettingsInput
    • ApiPublicPaymentProcessorDetails
    • User
    • CfdiError
    • ApiPublicPayment
    • UserInput
    • ClientAddress
    • TaxSchema
    • RequestPaymentInput
    • StandardSuccessResponse
    • RegisterPaymentInput
    • ListResponse
    • ErrorResponse
    • RefundPaymentInput
    • ValidationErrorResponse
    • ApiPublicIncomeInvoice
    • MarkPaymentAsPaidInput
    • UnauthorizedError
    • ApiPublicTeam
    • ApiPublicUser
    • NotFoundError
    • ApiPublicSearch
    • InternalServerError
    • ApiPublicThirdParty
    • ApiPublicInvoiceConfig
    • ApiPublicRefund
    • TeamSettings
    • ApiPublicAutomations
    • TaxElement
    • SeriesInput
    • Series
    • ApiPublicWebhook
    • ReceiptInput
    • WebhookInput
    • WebhookUpdateInput
    • PaymentMethodEnum
    • PaymentFormEnum
    • AutomationTypeEnum
    • ItemSchema
    • SATDocument
    • UploadSupportDocumentInput
  1. Clients

Search clients

GET
https://api.gigstack.io/v2/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

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Query Params

Responses

🟢200OK
application/json
Clients searched successfully
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gigstack.io/v2/clients/search?team&q&query&limit&page&fields=id,description,created_at'
Response Response Example
200 - Example 1
{
    "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": {
                "keep_full_legal_name": false,
                "issue_automatic_invoices": false,
                "issue_invoiceable_receipts": true
            }
        }
    ],
    "found": 15,
    "page": 1,
    "per_page": 10,
    "success": true,
    "timestamp": 1677651234000
}
Modified at 2026-03-06 19:07:26
Previous
Delete client
Next
Upload CSF PDF to create or update client
Built with