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
    • Health check
      GET
  • Services
    • Services API Guide
    • List services
      GET
    • Get service
      GET
    • Update service
      PUT
    • Create service
      POST
    • Delete service
      DELETE
    • Health check
      GET
  • Invoices
    • Invoices API Guide
    • Income
      • List income invoices
      • Create income invoice
      • Get income invoice
    • Egress
      • List egress invoices
      • Create egress invoice
      • Get egress invoice
    • Drafts
      • Create draft invoice (pre-factura)
      • Stamp draft invoice (finalize)
      • Generate draft preview PDF (pre-factura)
      • Delete draft invoice
      • Update draft invoice
      • Get draft invoice
      • List draft invoices
    • 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
    • List SAT invoices
      GET
    • Get a SAT invoice
      GET
    • Retry XML download
      POST
    • Generate PDF for a received SAT invoice
      POST
    • Create payment complement (complemento de pago)
      POST
    • Resend invoice email
      POST
    • Get invoice
      GET
    • Health check
      GET
    • Trigger end-of-month global invoicing
      POST
    • Connect FIEL credentials from a PFX file
      POST
    • Update bulk-download sync period
      PUT
  • Payments
    • Payments API Guide
    • List payments
    • Get payment
    • Request payment
    • Register payment
    • Mark payment as paid
    • Refund payment
    • Cancel payment
    • Search payments
    • Update payment
    • Upload support document
    • List support documents
    • Health check
  • Receipts
    • Receipts API Guide
    • List receipts
    • Get receipt
    • Create receipt
    • Stamp receipt
    • Cancel receipt
    • Search receipts
    • Health check
  • Teams
    • Teams API Guide
    • List teams
    • Get team
    • Get team integrations (not implemented)
    • 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
    • Delete team
    • Upload SAT CSD certificates
    • Sign manifest document
    • Health check
  • Users
    • Users API Guide
    • List users
    • Get user
    • Update user
    • Create user
    • Reset user password
    • Generate login link
    • Delete user
    • Reset user password
    • Health check
  • 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)
    • Search SAT product keys
    • Search SAT unit keys
    • Health check
  • Webhooks
    • Webhooks
    • List webhooks
    • Create webhook
    • Get webhook
    • Update webhook
    • Delete webhook
    • Health check
  • Retentions
    • Retentions
    • List retentions
    • Create retention
    • Get retention
    • Cancel retention
    • Get retention files
  • Descarga Masiva SAT
    • Descarga Masiva
    • Check activation status
    • Activate Descarga Masiva SAT
    • Deactivate Descarga Masiva SAT
    • Upload FIEL credentials
    • Register business with SAT (manual)
    • Get schedule configuration
    • Save schedule configuration
    • Get download request history
    • Create bulk download request
    • Check download request status
    • Download XML package
    • Get single invoice from SAT
    • Debug registration status
    • Enable SAT sync
  • Auth
    • Headless signup (API-only path)
    • Health check
  • SAT Lists
    • List SAT lists and sync status
    • Check an RFC against the SAT lists
  • Documents
    • List documents
    • Create document
    • Get document
    • Update document
    • Delete document
    • Analyze document with AI
    • Link document to an entity
    • Unlink document from an entity
  • Apidog connectivity test
    GET
  • Schemas
    • Schemas
      • ApiResponse
      • Category
      • Pet
      • Tag
      • Order
      • StandardizedSuccessResponse
      • StandardizedErrorResponse
      • ApiErrorCode
    • RequestBodies
      • UserArray
    • SatInvoice
    • DateRangeFilter
    • OrderDirection
    • ListQueryParams
    • PaginationMeta
    • ApiPublicProductKey
    • Client
    • ApiPublicUnitKey
    • ApiPublicService
    • ApiPublicClient
    • Service
    • PendingReceiptsSummary
    • ClientInput
    • CfdiError
    • ServiceInput
    • Invoice
    • DraftInvoiceInput
    • DraftInvoiceUpdateInput
    • DraftInvoiceOutput
    • PaymentComplementRelatedDocument
    • InvoiceIncomeInput
    • PaymentComplementPayment
    • InvoiceEgressInput
    • PaymentItem
    • PaymentComplementInput
    • PaymentAllowedMethod
    • InvoiceInput
    • ApiPublicPaymentProcessorDetails
    • ApiPublicPayment
    • Payment
    • PaymentInput
    • RequestPaymentInput
    • RegisterPaymentInput
    • RefundPaymentInput
    • InvoiceConfigInput
    • MarkPaymentAsPaidInput
    • UpdatePaymentInput
    • ApiPublicUser
    • ApiPublicWebhook
    • ApiPublicIncomeInvoice
    • ApiPublicTeam
    • Team
    • WebhookInput
    • WebhookUpdateInput
    • TeamInput
    • User
    • TeamSettingsInput
    • TeamSettings
    • SeriesInput
    • Series
    • UserInput
    • ApiPublicSearch
    • ApiPublicThirdParty
    • ApiPublicInvoiceConfig
    • ReceiptInput
    • DocumentTypeEnum
    • ApiPublicRefund
    • DocumentComplianceStatusEnum
    • ApiPublicAutomations
    • TeamTaxDefault
    • DocumentLinkEntityTypeEnum
    • DocumentInput
    • BadRequestError
    • DocumentUpdateInput
    • ClientAddress
    • DocumentLinkInput
    • SatListRfcCheck
    • ApiPublicDocument
    • PaymentMethodEnum
    • TaxElement
    • PaymentFormEnum
    • SatListDefinition
    • TaxSchema
    • AutomationTypeEnum
    • StandardSuccessResponse
    • StandardErrorResponse
    • SATDocument
    • UploadSupportDocumentInput
    • HealthResponse
    • CfdiErrorResponse
    • CreditLimitResponse
    • ListResponse
    • SearchResponse
    • ErrorResponse
    • ValidationErrorResponse
    • UnauthorizedError
    • NotFoundError
    • InternalServerError
    • LegacyErrorResponse
    • ItemSchema
  1. Clients

Health check

GET
https://api.gigstack.io/v2/clients/health
Liveness probe for the clients module. Unauthenticated.

Request

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

Responses

🟢200OK
application/json
Healthy
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.gigstack.io/v2/clients/health'
Response Response Example
{
    "status": "ok",
    "module": "clients"
}
Modified at 2026-08-05 21:48:25
Previous
List support documents
Next
Services API Guide
Built with