> ## 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.

# List API logs

> Read retained logs for the authorized target team and credential mode. Firebase/MCP callers need current viewer-or-higher access; team API/OAuth credentials remain subject to target/sibling-team authorization. Signed API, MCP and OAuth credentials keep their issued mode. Output excludes raw bodies, headers, credentials, signed URLs and arbitrary provider text. This is a metadata/structure view, not a complete original-payload export. A filtered page can be empty while has_more is true. Continue with next_cursor until null; cursor includes timestamp and ID so deleting the anchor does not restart pagination. Unsupported stored cursor timestamps return log_pagination_unavailable rather than falsely claiming the history ended. Logs use the same teamId field as the web API-log view; legacy records using only another team field are not silently merged. Existing retention applies. The browser may supply livemode only with an independently reverified Firebase ID token; the selector must equal the authenticated request mode. Signed API, MCP and OAuth credentials cannot use this selector, even to repeat their own mode. API details additionally retain allowlisted fiscal amounts, flags and catalog values with explicit redaction/truncation markers. Requests revalidate the original credential and current account/team/mode after asynchronous reads.



## OpenAPI

````yaml openapi.json GET /teams/{id}/api-logs
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. Internal partner
    provisioning is outside this public contract; 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: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/api-logs:
    get:
      tags:
        - Teams
      summary: List API logs
      description: >-
        Read retained logs for the authorized target team and credential mode.
        Firebase/MCP callers need current viewer-or-higher access; team
        API/OAuth credentials remain subject to target/sibling-team
        authorization. Signed API, MCP and OAuth credentials keep their issued
        mode. Output excludes raw bodies, headers, credentials, signed URLs and
        arbitrary provider text. This is a metadata/structure view, not a
        complete original-payload export. A filtered page can be empty while
        has_more is true. Continue with next_cursor until null; cursor includes
        timestamp and ID so deleting the anchor does not restart pagination.
        Unsupported stored cursor timestamps return log_pagination_unavailable
        rather than falsely claiming the history ended. Logs use the same teamId
        field as the web API-log view; legacy records using only another team
        field are not silently merged. Existing retention applies. The browser
        may supply livemode only with an independently reverified Firebase ID
        token; the selector must equal the authenticated request mode. Signed
        API, MCP and OAuth credentials cannot use this selector, even to repeat
        their own mode. API details additionally retain allowlisted fiscal
        amounts, flags and catalog values with explicit redaction/truncation
        markers. Requests revalidate the original credential and current
        account/team/mode after asynchronous reads.
      operationId: listApiLogs
      parameters:
        - name: id
          in: path
          required: true
          schema:
            pattern: ^[A-Za-z0-9_-]{1,160}$
            type: string
        - $ref: '#/components/parameters/TeamParameter'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Maximum rows scanned, not number of matching results.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Use next_cursor with the same team, credential mode and all filters,
            including limit.
        - name: from
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: Inclusive epoch milliseconds.
        - name: to
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
          description: Inclusive epoch milliseconds.
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - 2xx
              - 3xx
              - 4xx
              - 5xx
          description: Result filter applied within each bounded scan.
        - name: method
          in: query
          required: false
          schema:
            type: string
            enum:
              - GET
              - POST
              - PUT
              - PATCH
              - DELETE
              - OPTIONS
              - HEAD
          description: HTTP method.
        - name: endpoint
          in: query
          required: false
          schema:
            type: string
            pattern: ^/[A-Za-z0-9_/:.-]{0,255}$
          description: >-
            Prefix of the redacted route; variable segments are :id. Current and
            historical leading-slash forms are normalized.
        - name: livemode
          in: query
          required: false
          schema:
            type: boolean
          description: >-
            Firebase browser transport only: select live (true) or test (false)
            history. The original Firebase token is reverified, including
            revocation, and the selected mode must match its authenticated
            request context. Omit for API, MCP and OAuth credentials; they use
            their issued mode.
      responses:
        '200':
          description: Redacted log metadata and documented pagination/detail structure.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AccountApiLog'
                  has_more:
                    type: boolean
                  next_cursor:
                    type: string
                    nullable: true
                  scanned_count:
                    type: integer
                    minimum: 0
                    maximum: 100
                  livemode:
                    type: boolean
                required:
                  - success
                  - data
                  - has_more
                  - next_cursor
                  - scanned_count
                  - livemode
              example:
                success: true
                data:
                  - id: log_example
                    timestamp: 1700000000000
                    method: POST
                    endpoint: /v2/invoices/:id
                    status_code: 400
                    livemode: false
                    redaction: metadata_and_body_shape
                    team_id: team_example
                has_more: false
                next_cursor: null
                scanned_count: 1
                livemode: false
        '400':
          description: >-
            Invalid ID, mode_required, invalid_filter or invalid_cursor. Filters
            must be single values; duplicate/array values are rejected.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            Current team read authority is missing, blocked, inactive or
            ambiguous.
        '404':
          description: Team/log not found in the authorized team and credential mode.
        '409':
          description: >-
            log_pagination_unavailable: a stored cursor timestamp cannot safely
            be used. This does not prove the history is exhausted. mode_changed:
            the Firebase browser selector differs from the authenticated request
            mode. Refresh context before reading again.
        '500':
          description: log_read_failed. No provider action was attempted.
      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:
    AccountApiLog:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        timestamp:
          type: number
          nullable: true
        method:
          type: string
          nullable: true
          enum:
            - GET
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - HEAD
            - null
        endpoint:
          type: string
          nullable: true
        status_code:
          type: number
          nullable: true
        livemode:
          type: boolean
        redaction:
          type: string
          enum:
            - metadata_and_body_shape
        team_id:
          pattern: ^[A-Za-z0-9_-]{1,160}$
          type: string
      required:
        - id
        - timestamp
        - method
        - endpoint
        - status_code
        - livemode
        - redaction
        - team_id
    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
    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 `"<field path>: <message>"` strings.
              example:
                - 'currency: Field is required'
        timestamp:
          type: integer
          format: int64
          description: Server time in epoch milliseconds.
          example: 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.