> ## Documentation Index
> Fetch the complete documentation index at: https://developers.zite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read logs

> Read workflow execution logs — inputs, outputs, console output, and stack traces.

Returns [workflow](/concepts/workflows) execution logs — inputs, outputs, console output, and
stack traces. Logs are retained for 90 days. See [Troubleshooting](/troubleshooting) for common runtime
errors and fixes.


## OpenAPI

````yaml build-api/openapi.json GET /apps/{appId}/logs
openapi: 3.0.1
info:
  title: Zite Build API
  description: >-
    Create, build, and deploy Zite apps programmatically — the REST equivalent
    of the Zite MCP build tools. Use it from a script, a CI pipeline, or your
    own agent.


    ## Authentication


    All requests require a Bearer API key from your Developer settings:

    ```

    Authorization: Bearer YOUR_API_KEY

    ```

    The key acts as you — it can only see and change workspaces you have access
    to, and every change is attributed to you.


    ## Base URL


    https://api.zite.com/v1


    ## Errors


    Errors return `{ "statusCode": 404, "error": "Not Found", "message":
    "Workspace not found" }`. Notable statuses: `401` (bad or missing key),
    `402` (the build tools aren't in your plan), `404`, `409` (a commit push
    conflict — pull, rebase, and commit again), and `400` for validation
    failures and publishing before a build is green.
  version: 1.0.0
servers:
  - url: https://api.zite.com/v1
    description: Zite Build API
security:
  - bearerAuth: []
tags:
  - name: Workspaces
    description: Create workspaces and inspect the apps in them.
  - name: Build sessions
    description: >-
      Open an isolated checkout of a workspace, create apps, edit files, check,
      and commit.
  - name: Deployments
    description: Publish built apps, manage versions, roll back, and read runtime logs.
paths:
  /apps/{appId}/logs:
    get:
      tags:
        - Deployments
      summary: Read logs
      description: >-
        Returns endpoint execution logs — inputs, outputs, console output, and
        stack traces. Logs are retained for 90 days.
      operationId: readLogs
      parameters:
        - $ref: '#/components/parameters/AppId'
        - name: status
          in: query
          required: false
          description: Filter by outcome.
          schema:
            type: string
            enum:
              - all
              - success
              - error
            default: all
        - name: mode
          in: query
          required: false
          description: Which environment to read from.
          schema:
            type: string
            enum:
              - live
              - preview
              - both
            default: both
        - name: limit
          in: query
          required: false
          description: Max runs to return.
          schema:
            type: integer
            minimum: 1
            maximum: 50
        - name: hoursAgo
          in: query
          required: false
          description: Lookback window in hours.
          schema:
            type: integer
            minimum: 1
            maximum: 168
            default: 24
      responses:
        '200':
          description: Endpoint execution runs
          content:
            application/json:
              schema:
                type: object
                properties:
                  runs:
                    type: array
                    items:
                      $ref: '#/components/schemas/LogRun'
                  totalCount:
                    type: integer
              example:
                runs:
                  - endpoint: listTickets
                    status: error
                    startedAt: '2026-07-13T18:04:11Z'
                    durationMs: 142
                    error: 'invalid input syntax for type timestamp: ""'
                totalCount: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    AppId:
      name: appId
      in: path
      required: true
      description: The app ID.
      schema:
        type: string
      example: app_a1b2c3
  schemas:
    LogRun:
      type: object
      properties:
        endpoint:
          type: string
          example: listTickets
        status:
          type: string
          enum:
            - success
            - error
          example: error
        startedAt:
          type: string
          format: date-time
          example: '2026-07-13T18:04:11Z'
        durationMs:
          type: integer
          example: 142
        error:
          type: string
          nullable: true
          description: Error message when `status` is `error`; `null` otherwise.
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: Workspace not found
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Missing or invalid API key.
    NotFound:
      description: The resource does not exist or your key cannot access it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Workspace not found.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Enter your Zite API key. Format: Bearer <api_key>'

````