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

# Get Workspace Sync Package

> Read the managed resources package selection of the source workspace.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/workflows/sync/package
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/workflows/sync/package:
    get:
      tags:
        - workflows
      summary: Get Workspace Sync Package
      description: Read the managed resources package selection of the source workspace.
      operationId: workflows-get_workspace_sync_package
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
        - name: ref
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 255
              - type: 'null'
            title: Ref
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspacePackageRead'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSyncExportError'
          description: Bad Request
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    WorkspacePackageRead:
      properties:
        is_source:
          type: boolean
          title: Is Source
          description: Whether this workspace is the managed resources source.
        ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Ref
          description: Branch the include file was read from.
        patterns:
          items:
            type: string
          type: array
          title: Patterns
          description: Include file patterns in file order.
        resources:
          items:
            $ref: '#/components/schemas/WorkspacePackageResource'
          type: array
          title: Resources
          description: Every syncable resource with its package status.
        warnings:
          items:
            type: string
          type: array
          title: Warnings
          description: Include file problems worth fixing.
      type: object
      required:
        - is_source
      title: WorkspacePackageRead
      description: The managed resources package selection of the source workspace.
    WorkspaceSyncExportError:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable failure summary.
        diagnostics:
          items:
            $ref: '#/components/schemas/WorkflowExportDiagnostic'
          type: array
          title: Diagnostics
        omitted_count:
          type: integer
          title: Omitted Count
          default: 0
      type: object
      required:
        - detail
      title: WorkspaceSyncExportError
      description: Additive diagnostics while retaining the legacy string detail field.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkspacePackageResource:
      properties:
        resource_type:
          $ref: '#/components/schemas/SyncResourceType'
          description: Kind of resource.
        source_id:
          type: string
          title: Source Id
          description: Stable Git source id.
        local_id:
          type: string
          format: uuid
          title: Local Id
          description: Workspace-local resource id.
        name:
          type: string
          title: Name
          description: Human-readable resource name.
        path:
          type: string
          title: Path
          description: Primary repository path of the resource.
        pattern:
          type: string
          title: Pattern
          description: Include pattern that selects the resource.
        status:
          $ref: '#/components/schemas/PackageResourceStatus'
          description: >-
            ``explicit`` when a pattern selects it, ``implied`` when only a
            dependency, ``excluded`` otherwise.
        implied_by:
          items:
            type: string
          type: array
          title: Implied By
          description: Names of the explicit resources that need an implied one.
      type: object
      required:
        - resource_type
        - source_id
        - local_id
        - name
        - path
        - pattern
        - status
      title: WorkspacePackageResource
      description: One source workspace resource as the package picker shows it.
    WorkflowExportDiagnostic:
      properties:
        workflow_id:
          type: string
          format: uuid
          title: Workflow Id
          description: Authorized local workflow ID.
        workflow_title:
          type: string
          title: Workflow Title
          description: Workflow display title.
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
          description: Existing stable Git ID.
        source_path:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Path
          description: Existing repository path.
        stage:
          $ref: '#/components/schemas/WorkflowExportStage'
          description: Export stage that failed.
        code:
          $ref: '#/components/schemas/WorkflowExportCode'
          description: Machine-readable corrective error code.
        message:
          type: string
          title: Message
          description: Safe corrective message without workflow inputs.
      type: object
      required:
        - workflow_id
        - workflow_title
        - stage
        - code
        - message
      title: WorkflowExportDiagnostic
      description: Safe workflow context for an export that cannot proceed.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SyncResourceType:
      type: string
      enum:
        - workflow
        - agent_preset
        - skill
        - table
        - case_tag
        - case_field
        - case_dropdown
        - case_duration
        - variable
        - secret_metadata
      title: SyncResourceType
      description: |-
        Kind of workspace resource that can be synced to and from Git.

        Every member is adapter-backed: it can be projected to and imported from
        repository files.
    PackageResourceStatus:
      type: string
      enum:
        - explicit
        - implied
        - excluded
    WorkflowExportStage:
      type: string
      enum:
        - definition
        - dependency
    WorkflowExportCode:
      type: string
      enum:
        - publish_required
        - missing_definition
        - no_actions
        - invalid_definition
        - missing_child_workflow
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.