> ## Documentation Index > Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt > Use this file to discover all available pages before exploring further. # Create receipt > [Small working example](/recipes/receipt) **Integration note:** A receipt is not yet a stamped CFDI. Repeating a creation idempotency_key returned HTTP 400 resource_conflict in staging. The tested response returned payment_form null despite a request value of 03; verify the fiscal document before issuing it. Create a new receipt with items and client information. Receipts are pre-invoice documents that can be later stamped as CFDI invoices. **Features:** - Automatic amount calculations with taxes - Flexible validity periods - Client auto-creation support - Metadata support for tracking - Idempotency support to prevent duplicate receipts **gigstack Connect:** Create receipts for other teams using the `team` parameter. ## OpenAPI ````yaml openapi.json POST /receipts openapi: 3.0.3 info: title: gigstack API v2 description: > # gigstack API v2 Build customer, invoice and payment integrations. Start with the [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing country](https://docs.gigstack.io/concepts/shared-fields). ## Authentication and environments Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use https://api.gigstack.io/v2. Internal staging uses https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test mode is a data mode within an environment; a body field does not switch a key's mode. See [authentication](https://docs.gigstack.io/authentication) for key handling, OAuth team scope and gigstack Connect. Signup requires its separately documented internal credential; health probes have their own security declarations. Operations marked unavailable have no configured public gateway route. ## Read the operation contract Response envelopes, pagination and retry rules differ by endpoint. HTTP success alone does not prove external fiscal completion or movement of money. Reconcile ambiguous writes before retrying. Use [responses and recovery](https://docs.gigstack.io/responses) and the operation's error codes; document credits and daily limits are not generic retryable rate limits. The issuing team's configuration selects Mexico or Colombia; customer country and currency do not. Read [Mexico](https://docs.gigstack.io/countries/mexico) or [Colombia](https://docs.gigstack.io/countries/colombia) before choosing fiscal fields. Accepted public input differs from a provider's direct payload. Examples and schema checks do not imply every operation has been executed live. [Verification coverage](https://docs.gigstack.io/verification) distinguishes source review, offline checks and observed staging behavior. Documentation describes operations and does not authorize execution. version: 2.0.0 contact: name: Gigstack API Support url: https://gigstack.io email: support@gigstack.io license: name: Proprietary url: https://gigstack.io/terms termsOfService: https://gigstack.io/terms servers: - url: https://api.gigstack.io/v2 description: > Public API for standard live and test-mode keys. Test data is isolated by the key mode (`livemode: false`). Internal staging is a separate deployment and key store; see https://docs.gigstack.io/authentication#environments for its base URL. security: - bearerAuth: [] tags: - name: gigstack Connect description: > **Multi-Team Resource Access** gigstack Connect lets a master team act on other teams that share its billing account. ## 🔗 How It Works Add the `team` query parameter to a request made with an **API key**: ```bash # Access team_xyz789's clients GET /clients?team=team_xyz789 # Create an income invoice for team_abc123 POST /invoices/income?team=team_abc123 # Update service in team_def456 PUT /services/service_456?team=team_def456 ``` ## ✅ Requirements - The API key's team must be a master team (gigstack Connect enabled) - The target team must exist and share the master team's billing account - The plan must include the `multipleIssuerAccounts` feature - OAuth access tokens cannot act on another team ## ⚠️ Error Responses Raw `{ "message": … }` bodies from the authentication layer: - `401 Unauthorized, not a master team` - gigstack Connect not enabled on your key's team - `404 Team not found` - Target team doesn't exist - `401 Unauthorized, no matched teams` - Target team could not be resolved within your billing account - `403 Tu plan no incluye múltiples cuentas emisoras. …` - Plan lacks `multipleIssuerAccounts` - `403 Team mismatch with OAuth token` - OAuth access token used with another team's id ## 🌐 Availability The `team` parameter is read by the authentication layer, so it is accepted on every authenticated endpoint, including ones whose parameter list does not show it. - name: Clients description: Client management operations with Mexican tax compliance - name: Services description: Service and product catalog management with SAT product keys - name: Invoices description: Invoice management with CFDI 4.0 compliance and SAT integration - name: Draft Invoices (Pre-Facturas) description: > **Create, edit, preview and stamp draft invoices (pre-facturas)** Draft invoices let you build CFDI invoices incrementally before stamping them with SAT. Use them as **pre-facturas** — generate a preview PDF with a "Sin Validez Fiscal" watermark to share with your client for approval, then stamp the draft to create a valid CFDI when ready. ## Typical Workflow 1. `POST /invoices/draft` — Create a draft with minimal data 2. `PUT /invoices/draft/{id}` — Update as more data becomes available 3. `POST /invoices/draft/{id}/preview` — Generate a preview PDF (pre-factura) 4. `POST /invoices/draft/{id}/stamp` — Finalize into a valid CFDI invoice - name: Descarga Masiva SAT description: > **SAT bulk invoice download via FIEL authentication** Download all your issued and received CFDI invoices directly from the SAT (Servicio de Administración Tributaria) using your FIEL (Firma Electrónica Avanzada). ## Setup flow 1. `GET /invoices/download/activate/status` — Check if activated and what's needed 2. `POST /invoices/download/activate` — Activate billing (adds Stripe meter/add-on) 3. `POST /invoices/download/fiel` — Upload `.cer` + `.key` files (auto-registers with SAT) 4. `PUT /invoices/download/schedule` — Configure daily auto-sync 5. `POST /invoices/download/request` — Submit manual download requests ## Pricing - Included in Pro/Business plans: only the download meter ($0.20 MXN/XML) - Other paid plans: the same $0.20 MXN/XML download meter, no monthly base fee - name: Payments description: Payment processing, tracking, and refund management - name: Receipts description: Receipt creation and management with CFDI stamping capabilities - name: Retentions description: >- Tax retention documents (CFDI Retenciones 2.0) — creation, stamping, cancellation, and file retrieval - name: Platform Payouts description: > **Plan and stamp a marketplace's provider payouts from two files.** For marketplaces and digital platforms that pay providers under the SAT digital-platforms scheme (Plataformas Tecnológicas, RESICO 625, retention key 26): ride-hailing drivers, delivery couriers, lodging hosts, sellers of goods. Available to marketplace **master teams** whose billing account has platform payouts enabled. Upload a movements file and a commissions file. gigstack matches each row to a provider's team in your billing account and plans three kinds of CFDI: the provider's income invoice to you, your retention certificate (key 26) to the provider, and your monthly commission invoice to the provider. **Not for your own sales.** This is for a platform invoicing on behalf of its providers. A company invoicing its own sales, one CFDI per sale, should use `POST /invoices/income`. **Tax policy per account.** Which documents are issued, and with which SAT keys and rates, is set per master account at onboarding: allowed tax regimes, CSD requirement, service type (`tipoDeServ` / `subTipServ`), ISR and IVA withholding rates, product keys and concept descriptions. The defaults are for ground passenger transport (service type `01`, 2.1% ISR withholding). Contact support to configure your account's policy; it can't be changed through the API. 1. `POST /platform-payouts` with an `Idempotency-Key` - upload and plan (synchronous) 2. `GET /platform-payouts/{id}` and `GET /platform-payouts/{id}/movements` - review the plan 3. `POST /platform-payouts/{id}/confirm` - irreversible hand-off to the stamping worker 4. `GET /platform-payouts/{id}` - poll until `completed` or `failed`, then read `result` (`completed`, `partially_completed` or `failed`) Error messages and exclusion reasons are Spanish sentences for end users; branch on `error.code`, `reason_code` and `exclusion_codes`. - name: Documents description: > SAT supporting documentation (contracts, delivery/payment proofs, communications) — upload metadata, compliance review, AI extraction, and linking to invoices, payments, receipts and clients. - name: Teams description: Team management, settings, and member administration - name: Users description: User account management and password operations - name: Auth description: > **API-only signup for AI agents and partner integrations.** A single `POST /v2/auth/signup` call provisions a Firebase Auth user, billing account, team, plan subscription, and returns API keys — no UI, no FIEL upload, no human onboarding required. Designed for the AI-agents-as-customers use case. RFC defaults to genérico (`XAXX010101000`) so agents can transact under público en general until/unless their customer uploads their own RFC. Authenticated with `X-Internal-API-Key` (partner-issued) — Bearer tokens are team-scoped and a brand-new caller doesn't have one yet. See `AGENTS.md` in the gigstack-cli repo for end-to-end integration guide. - name: Webhooks description: Webhook management for real-time event notifications - name: Catalogs description: > **Read-only search over the SAT catalogs** Look up the SAT codes required on CFDI line items without hardcoding them: - `GET /catalogs/product-keys` — `c_ClaveProdServ`, the item `product_key` - `GET /catalogs/unit-keys` — `c_ClaveUnidad`, the item `unit_key` / `unit_name` Both are typo-tolerant full-text searches ranked by relevance. The catalogs are published by the SAT and identical for every team, so results carry no team data and ignore `livemode` — but a valid API key is still required. - name: SAT Lists description: > Read-only access to the RFC lists the SAT publishes under Artículo 69, 69-B and 69-B Bis. gigstack re-syncs all 22 lists from the SAT's published CSVs every Sunday, so you can screen a counterparty's RFC before invoicing it without scraping the SAT yourself. externalDocs: description: Complete API Documentation & Guides url: https://docs.gigstack.io paths: /receipts: post: tags: - Receipts summary: Create receipt description: > [Small working example](/recipes/receipt) **Integration note:** A receipt is not yet a stamped CFDI. Repeating a creation idempotency_key returned HTTP 400 resource_conflict in staging. The tested response returned payment_form null despite a request value of 03; verify the fiscal document before issuing it. Create a new receipt with items and client information. Receipts are pre-invoice documents that can be later stamped as CFDI invoices. **Features:** - Automatic amount calculations with taxes - Flexible validity periods - Client auto-creation support - Metadata support for tracking - Idempotency support to prevent duplicate receipts **gigstack Connect:** Create receipts for other teams using the `team` parameter. operationId: createReceipts parameters: - $ref: '#/components/parameters/TeamParameter' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReceiptInput' example: client: id: client_1234567890 currency: MXN items: - id: service_1234567890 quantity: 1 periodicity: month payment_form: '03' idempotency_key: receipt-key-12345 metadata: order_id: ORD-12345 responses: '201': description: > Receipt created successfully. The receipt is stored with `status: pending` — no PAC call happens here, so no PAC-related error can be returned by this operation. Stamping happens later, via `POST /v2/receipts/{id}/stamp` or the self-invoicing portal. content: application/json: schema: allOf: - $ref: '#/components/schemas/StandardSuccessResponse' - type: object properties: message: type: string example: Receipt created successfully example: success: true data: id: receipt_1234567890 client: 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 currency: MXN exchange_rate: 1 from: api url: >- https://invoicing.gigstack.pro/autofactura?id=receipt_1234567890 created_at: 1767225600000 invoices: [] items: - id: service_1234567890 description: Servicios de consultoría profesional quantity: 1 unit_price: 1000 product_key: '80141503' unit_key: E48 unit_name: Unidad de servicio taxes: - type: IVA rate: 0.16 factor: Tasa withholding: false team: team_1234567890 created_at: 1767225600000 from: api livemode: true metadata: order_id: ORD-12345 owner: user_1234567890 payments: - payment_1234567890 periodicity: month short_url: https://gigstack.xyz/Rc8vQ2 status: pending team: team_1234567890 valid_until: 1769817600000 automatic_invoice_error: null payment_form: '03' total: 1160 total_refunded: 0 subtotal: 1000 taxes: 160 discount: 0 withholding_taxes: 0 idempotency_key: receipt-key-12345 message: Receipt created successfully timestamp: 1767225600000 '400': description: > Bad Request. `error.code`: - `validation_failed` — schema failure, including unknown keys. - `invalid_request_body` — `Items are required for receipt creation`, `Exchange rate not found`. - `resource_conflict` — the supplied `idempotency_key` already exists. Note the status is **400**, not 409, despite the code name. - `resource_resolution_failed` — the `client`/`items` reference could not be resolved (e.g. both `id` and `search` supplied, or `safety_check` matched several records). content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- Referenced client or service belongs to another team, or `livemode` mismatch. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: Referenced client or service id was not found. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' '409': description: >- A concurrent create holds the client/service lock — retry the request. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '429': description: > Team credit limit reached. Returned in the standardized envelope with `error.code: team_credit_limit_reached`; `error.details` carries the reason reported by the credit checker. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: success: false error: code: team_credit_limit_reached message: Team credit limit reached details: >- Credit limit of 100 documents reached for this billing period timestamp: 1767225600000 '500': description: Internal Server Error — `An error occurred while creating receipt`. content: application/json: schema: $ref: '#/components/schemas/InternalServerError' security: - bearerAuth: [] components: parameters: TeamParameter: name: team in: query required: false schema: type: string description: > **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` schemas: ReceiptInput: description: > Unknown top-level keys are rejected (`400 validation_failed` / `unexpected_key`); `metadata` is the one object that accepts arbitrary keys. `team`, `livemode` and `owner` are reserved and injected by the auth middleware. type: object additionalProperties: false required: - client - currency - items properties: client: $ref: '#/components/schemas/EmbeddedClientInput' currency: description: Currency code (ISO 4217) example: MXN type: string exchange_rate: description: Exchange rate to use for currency conversion example: 1 type: number nullable: true items: description: Receipt items type: array items: $ref: '#/components/schemas/ItemSchema' metadata: description: >- Additional metadata - accepts any custom properties for tracking business data, references, or integration identifiers. All properties are preserved and returned as-is. type: object additionalProperties: true properties: {} nullable: true periodicity: description: > Receipt validity period. `two_month` and `two_months` are both accepted and mean the same period (end of the following month). example: month type: string enum: - day - week - two_weeks - month - two_month - two_months - null nullable: true invoice_config: description: > Invoice configuration for future stamping. Accepted and validated on this endpoint, but note the create-receipt handler does **not** currently persist it onto the receipt — it is validated and discarded. type: object additionalProperties: false properties: folio: type: number nullable: true serie: type: string nullable: true date: type: number nullable: true global: type: object additionalProperties: false properties: year: type: number nullable: true months: type: string nullable: true periodicity: type: string nullable: true nullable: true validUntil: type: number nullable: true payment_form: description: SAT payment form code example: '01' type: string nullable: true idempotency_key: description: >- Stable key for one business event. A duplicate returns HTTP 400 with error.code resource_conflict, not the existing receipt as a successful response. Reconcile the existing record and retain this key across retries. example: receipt-key-12345 type: string nullable: true send_email: description: >- Whether to send email and WhatsApp notifications for this receipt. Defaults to `true`. example: true type: boolean nullable: true ignore_emails: description: > Suppress email and WhatsApp notifications for this receipt. Takes precedence over `send_email` — the handler stores `ignore_emails ?? (send_email === false)`. example: false type: boolean nullable: true StandardSuccessResponse: type: object description: | Standardized success envelope emitted by `sendSuccessResponse`. required: - success - data - timestamp properties: success: type: boolean enum: - true example: true data: type: object description: The operation payload. message: type: string description: Human-readable summary. Present only when the handler supplies one. example: Operation completed successfully timestamp: type: integer format: int64 description: Server time in **epoch milliseconds** (`Luxon.now().toMillis()`). example: 1767225600000 ValidationErrorResponse: allOf: - $ref: '#/components/schemas/StandardErrorResponse' description: > Body validation failure. Unknown top-level keys are rejected — the validator runs in strict allowlist mode (`allowUnknown: false`), so a field not declared in the request schema produces an `unexpected_key` detail rather than being ignored. example: success: false error: code: validation_failed message: Request validation failed details: - 'currency: Field is required' - 'client_id: Unexpected field' timestamp: 1767225600000 StandardErrorResponse: type: object description: > Standardized error envelope emitted by `sendErrorResponse` and its helpers (`sendValidationError`, `sendNotFoundError`, `sendUnauthorizedError`, `sendForbiddenError`, `sendConflictError`, `sendBadRequestError`, `sendInternalServerError`). required: - success - error - timestamp properties: success: type: boolean enum: - false example: false error: type: object required: - code - message properties: code: type: string description: > Stable machine-readable code. Values emitted by the shared helpers: `unauthorized`, `forbidden`, `invalid_token`, `validation_failed`, `invalid_request_body`, `missing_required_field`, `invalid_field_value`, `resource_not_found`, `resource_already_exists`, `resource_conflict`, `business_rule_violation`, `operation_not_allowed`, `insufficient_permissions`, `external_service_error`, `payment_processor_error`, `cfdi_service_error`, `internal_server_error`, `service_unavailable`, `rate_limit_exceeded`, `database_error`, `data_integrity_error`, `file_not_found`, `file_upload_error`, `invalid_file_format`. Individual handlers may emit additional endpoint-specific codes, documented per operation. example: validation_failed message: type: string example: Request validation failed details: oneOf: - type: string - type: array items: type: string description: > Present only when the handler supplies detail. Validation failures emit an array of `": "` strings. example: - 'currency: Field is required' timestamp: type: integer format: int64 description: Server time in epoch milliseconds. example: 1767225600000 NotFoundError: allOf: - $ref: '#/components/schemas/StandardErrorResponse' example: success: false error: code: resource_not_found message: Resource not found timestamp: 1767225600000 InternalServerError: allOf: - $ref: '#/components/schemas/StandardErrorResponse' example: success: false error: code: internal_server_error message: An internal server error occurred timestamp: 1767225600000 EmbeddedClientInput: type: object additionalProperties: false properties: id: type: string nullable: true search: type: object additionalProperties: false required: - on_key - on_value properties: on_key: type: string on_value: type: string auto_create: type: boolean nullable: true safety_check: type: boolean nullable: true update: type: boolean nullable: true nullable: true address: type: object additionalProperties: false properties: country: type: string nullable: true maxLength: 3 street: type: string nullable: true zip: type: string nullable: true city: type: string nullable: true state: type: string nullable: true exterior: type: string nullable: true interior: type: string nullable: true municipality: type: string nullable: true neighborhood: type: string nullable: true nullable: true name: type: string nullable: true company: type: string nullable: true phone: type: string nullable: true email: type: string nullable: true bcc: type: array items: type: string metadata: type: object additionalProperties: true properties: {} legal_name: type: string nullable: true tax_id: type: string nullable: true use: type: string nullable: true tax_system: type: string nullable: true document_type: description: DIAN identification document code type: string enum: - '' - '11' - '12' - '13' - '21' - '22' - '31' - '41' - '42' - '47' - '48' - '50' - '91' - null nullable: true organization_type: description: 1 = persona jurídica, 2 = persona natural oneOf: - type: string enum: - '' - '1' - '2' - null nullable: true - type: number enum: - 1 - 2 tribute_code: description: '''01'' = responsable de IVA, ''ZZ'' = no aplica' type: string enum: - '' - '01' - ZZ - null nullable: true fiscal_responsibilities: description: >- DIAN responsabilidades fiscales (lista 53). Omitted means 'R-99-PN' (no responsable) type: array items: type: string enum: - O-13 - O-15 - O-23 - O-47 - R-99-PN nullable: true dv: description: NIT verification digit type: string nullable: true pattern: ^[0-9]?$ municipality_code: description: DANE municipality code, only for clients domiciled in Colombia type: string nullable: true pattern: ^([0-9]{5})?$ ItemSchema: description: > A line item on an invoice, receipt or payment. Only `quantity` is required; everything else is optional, or resolved from the referenced service when `id`/`search` is used. `id` and `search` are mutually exclusive — supplying both is a `400`. Unknown keys are rejected. Note there is no per-item `metadata` field. type: object additionalProperties: false required: - quantity properties: id: description: Service/product ID reference example: service_1234567890 type: string nullable: true search: type: object additionalProperties: false required: - on_key - on_value properties: on_key: description: Field to search on (sku, name, etc.) example: sku type: string on_value: description: Value to search for example: CONS-001 type: string auto_create: description: Create service if not found example: true type: boolean nullable: true safety_check: description: >- When true, prevents using multiple matching results (returns error). When false, uses the first result found. Default: false example: false type: boolean nullable: true update: type: boolean nullable: true nullable: true quantity: description: Item quantity example: 1 type: number description: description: Item description example: Consulting services type: string nullable: true sku: description: Stock keeping unit example: CONS-001 type: string nullable: true product_key: description: SAT product key (c_ClaveProdServ) example: '80141503' type: string nullable: true unit_key: description: SAT unit key (c_ClaveUnidad) example: E48 type: string nullable: true unit_name: description: Unit name example: Servicio type: string nullable: true unit_price: description: Unit price example: 1000 type: number nullable: true discount: description: >- Discount amount (absolute value in the item currency, not a percentage) example: 0 type: number nullable: true taxability: description: SAT `c_ObjetoImp` — whether the item is subject to tax. example: '02' type: string enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - null nullable: true taxes: description: Tax elements applied to this item type: array items: type: object additionalProperties: false properties: base: description: >- Taxable base amount. Accepts number or numeric string. If null, calculated automatically from item price. example: 100 oneOf: - type: number nullable: true - type: string description: Numeric string accepted by the request validator. factor: type: string nullable: true example: Tasa description: SAT tax factor (Tasa, Cuota, Exento) inclusive: type: boolean nullable: true example: false description: Whether the tax is included in the unit price rate: description: Tax rate (e.g., 0.16 for 16% IVA) example: 0.16 type: number nullable: true type: description: Type of tax example: IVA type: string enum: - IVA - ISR - IEPS - null nullable: true withholding: type: boolean nullable: true example: false description: Whether this is a withholding tax nullable: true third_party: description: Third party information for items provided by external parties type: object additionalProperties: false properties: legal_name: description: Third party legal name example: Third Party SA type: string nullable: true tax_id: description: Third party RFC (tax ID) example: TPR800101ABC type: string nullable: true tax_system: description: Third party tax system example: '601' type: string nullable: true zip: description: Third party ZIP code example: '03100' type: string nullable: true nullable: true item_complement: description: CFDI item-level complement. type: object additionalProperties: false properties: hydrocarbons: description: >- Complemento de hidrocarburos. All four fields are required when this object is present. type: object additionalProperties: false required: - permit_type - permit_number - fuel_code - fuel_sub_product properties: permit_type: example: PL/12345/EXP/ES/2020 type: string permit_number: example: '12345' type: string fuel_code: example: PR03 type: string fuel_sub_product: example: '10' type: string nullable: true nullable: true AuthMiddlewareError: type: object description: > Raw error body produced by the authentication layer (before any endpoint runs). It is not the standardized envelope: there is no `success` and no `timestamp`. required: - message properties: message: type: string description: >- Human-readable reason. Some messages are in Spanish; branch on the HTTP status, not on this text. example: Unauthorized error: type: string description: >- OAuth error code. Present only when an OAuth access token was presented. enum: - invalid_token - token_expired - token_revoked - server_error example: token_expired error_description: type: string description: Same text as `message`. Present only alongside `error`. example: Access token has expired. Please refresh your token. details: description: >- Extra detail, e.g. `Invalid API Key` when a revoked key is rejected with `403`. oneOf: - type: string - type: object example: Invalid API Key UnauthorizedError: allOf: - $ref: '#/components/schemas/StandardErrorResponse' example: success: false error: code: unauthorized message: Unauthorized access timestamp: 1767225600000 responses: Unauthorized: description: > Authentication failed. Two different bodies can come back with a `401`: 1. **From the authentication layer**, before the endpoint runs: a raw object with `message` and — for OAuth access tokens only — `error` / `error_description`. It does **not** use the standardized envelope (`success` and `timestamp` are absent). Messages: `Unauthorized` (missing header, missing `Bearer ` prefix, unparseable token), `Unauthorized, missing team in token`, `Unauthorized, not a master team` and `Unauthorized, no matched teams` (gigstack Connect), `Invalid access token`, `Access token has expired. Please refresh your token.`, `Access token has been revoked`. 2. **From the endpoint itself**: the standardized envelope with `error.code: unauthorized`. Branch on the HTTP status, not on the body shape. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthMiddlewareError' - $ref: '#/components/schemas/UnauthorizedError' examples: missing_or_invalid_key: summary: Authentication layer — missing or unparseable API key value: message: Unauthorized oauth_token_expired: summary: Authentication layer — expired OAuth access token value: message: Access token has expired. Please refresh your token. error: token_expired error_description: Access token has expired. Please refresh your token. connect_not_master_team: summary: >- Authentication layer — `team` sent by a team without gigstack Connect value: message: Unauthorized, not a master team endpoint_envelope: summary: Endpoint — standardized envelope value: success: false error: code: unauthorized message: Unauthorized access timestamp: 1767225600000 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > **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](https://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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.