> ## Documentation Index
> Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get schedule details

> Returns schedule details including recent run history.



## OpenAPI

````yaml /openapi.json get /schedules/{scheduleId}
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
paths:
  /schedules/{scheduleId}:
    get:
      tags:
        - Schedules
      summary: Get schedule details
      description: Returns schedule details including recent run history.
      operationId: getSchedule
      parameters:
        - $ref: '#/components/parameters/ScheduleId'
      responses:
        '200':
          description: Schedule details with runs.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ScanSchedule'
                  - type: object
                    properties:
                      runs:
                        type: array
                        items:
                          $ref: '#/components/schemas/ScheduleRun'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TierLimitError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - schedules:read
components:
  parameters:
    ScheduleId:
      name: scheduleId
      in: path
      required: true
      schema:
        type: string
  schemas:
    ScanSchedule:
      type: object
      properties:
        id:
          type: string
        cron:
          type: string
          description: Cron expression (5-field).
        isPaused:
          type: boolean
        createdAt:
          type: string
          format: date-time
        organization_id:
          type: string
        created_by:
          type: string
        name:
          type: string
        timezone:
          type: string
          description: IANA timezone.
        domain_ids:
          type:
            - array
            - 'null'
          items:
            type: string
        repository_ids:
          type:
            - array
            - 'null'
          items:
            type: string
        connector_id:
          type:
            - string
            - 'null'
        internal_targets:
          type: array
          items:
            type: string
        concerns:
          type:
            - string
            - 'null'
        focus:
          type:
            - string
            - 'null'
        context:
          type:
            - string
            - 'null'
        org_knowledge_enabled:
          type:
            - boolean
            - 'null'
        last_run_status:
          type:
            - string
            - 'null'
          enum:
            - ok
            - skipped
            - failing
            - null
        last_run_error:
          type:
            - string
            - 'null'
        last_run_code:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable cause of the last skipped/failing run, e.g.
            trial_scan_limit_reached
        next_run_at:
          type:
            - string
            - 'null'
          format: date-time
        last_run_at:
          type:
            - string
            - 'null'
          format: date-time
        run_count:
          type: integer
      required:
        - id
        - cron
        - isPaused
        - createdAt
        - name
        - timezone
        - run_count
    ScheduleRun:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        status:
          $ref: '#/components/schemas/ScanStatus'
        created_at:
          type: string
          format: date-time
        findings:
          $ref: '#/components/schemas/ScanFindings'
      required:
        - id
        - title
        - status
        - created_at
    ScanStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - cancelled
    ScanFindings:
      type: object
      properties:
        total:
          type: integer
        critical:
          type: integer
        high:
          type: integer
        medium:
          type: integer
        low:
          type: integer
      required:
        - total
        - critical
        - high
        - medium
        - low
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
    TierLimitErrorResponse:
      type: object
      properties:
        detail:
          type: string
        requiredTier:
          type: string
        code:
          type: string
      required:
        - detail
  responses:
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TierLimitError:
      description: Plan or credit limit reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TierLimitErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint. Include as `Authorization:
        Bearer <token>`.

````