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

# List account Work definitions

> Lists Work definitions from projects accessible to the current account context.



## OpenAPI

````yaml https://api.veryfront.com/openapi.json get /work
openapi: 3.1.0
info:
  title: Veryfront REST API
  version: 1.0.0
  summary: Domain-first REST reference for the maintained Veryfront HTTP API surface.
  description: >-
    Project-first HTTP API for Veryfront project resources. Root
    account/platform endpoints that still appear in this reference are
    transitional compatibility surfaces unless the canonical inventory marks
    them otherwise.


    ## Start here


    - **Interactive REST reference:** [/docs](/docs)

    - **Raw OpenAPI document:** [/openapi.json](/openapi.json)

    - **Canonical inventory:** `docs/api-surface-inventory.md` in this
    repository

    - **GraphQL endpoint:** [/graphql](/graphql)

    - **MCP playground:** [/mcp/playground](/mcp/playground)


    ## Authentication


    Use one of these request headers:


    - `Authorization: Bearer <jwt>`

    - `Authorization: Bearer vf_<prefix>_<secret>`

    - `X-API-Key: vf_<prefix>_<secret>`


    JWTs must use the Bearer token contract. API keys work in either the Bearer
    header or `X-API-Key`.


    ## Discovery model


    Veryfront is one platform with multiple access modes:


    - **REST** for resource-oriented and operational HTTP workflows

    - **GraphQL** for connected app-facing data and typed mutations

    - **MCP** for tool-style automation and agent workflows


    For the fastest path through the platform, start with the project-scoped
    domain groups. Transitional account/platform groups are retained for
    compatibility and follow the removal register in the canonical inventory.
  contact:
    name: Veryfront API Support
    url: https://veryfront.com/docs
    email: support@veryfront.com
servers:
  - url: https://api.veryfront.com
    description: Current request origin
  - url: http://localhost:4000
    description: Local development
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Projects
    description: Core project operations
  - name: Account
    description: >-
      Transitional account-level users and settings retained for dashboard
      compatibility
  - name: Project Users
    description: Project members and invites
  - name: Members
    description: Project members and invites
  - name: Files
    description: Main branch files
  - name: Branch Files
    description: Files on branches
  - name: Environment Files
    description: Files in environments
  - name: Release Files
    description: Files in releases
  - name: Uploads
    description: File uploads and assets
  - name: Branches
    description: Content branches for previews
  - name: Releases
    description: Published file snapshots
  - name: Deployments
    description: Connect releases to environments
  - name: Environments
    description: Deployment targets and variables
  - name: Environment Variables
    description: Project environment variable management
  - name: Domains
    description: Custom domains for environments
  - name: Project Servers
    description: Project-scoped dedicated server instances
  - name: Root Servers
    description: >-
      Transitional root dedicated-server administration retained for
      compatibility
  - name: Tasks
    description: Project tasks
  - name: Evals
    description: Project eval definitions and eval run projections
  - name: Work
    description: Project business-process definitions and execution state
  - name: Workflows
    description: Project workflows
  - name: Workflow Runs
    description: Workflow run history and status
  - name: Schedules
    description: Recurring project automation schedules
  - name: Webhooks
    description: Webhook-triggered automation entry points
  - name: Skills
    description: Project skills
  - name: Prompts
    description: Project prompts
  - name: Tools
    description: Project tools
  - name: Resources
    description: Project-defined resource documents and source-backed resource definitions
  - name: Sandboxes
    description: Ephemeral sandbox execution environments
  - name: Search
    description: Text and vector search
  - name: Knowledge
    description: Knowledge manifest lookup across project knowledge files
  - name: Chunks
    description: File chunks for search indexing
  - name: Embeddings
    description: Vector embeddings
  - name: RAG Documents
    description: Project retrieval-augmented knowledge documents
  - name: Style Artifacts
    description: Project style artifact state and build outputs
  - name: External Storage
    description: Transitional connected cloud-provider file operations
  - name: Project Cache
    description: Project-scoped distributed cache operations
  - name: User Cache
    description: Transitional user cache helpers retained for compatibility
  - name: API Keys
    description: >-
      Transitional user/account API key management; prefer project-scoped keys
      for public integrations
  - name: User
    description: Transitional current-user profile endpoint for first-party clients
  - name: Favorites
    description: Transitional user favorites for first-party dashboard clients
  - name: Subscriptions
    description: Transitional account billing and subscription workflows
  - name: Credits
    description: Transitional account credit balance, purchase, and insufficiency flows
  - name: Usage
    description: >-
      Project/account usage limits and warnings; account-level usage is
      transitional
  - name: Gates
    description: Transitional plan and feature gate checks for first-party clients
  - name: Channels
    description: Project channel integrations and delivery settings
  - name: Agents
    description: Project agents
  - name: Agent Catalog
    description: Public catalog of agents assembled from curated template projects
  - name: Agent Workers
    description: Internal/transitional agent worker leases and sessions
  - name: Agent Runtimes
    description: Registered push-based agent runtime services and runtime target health
  - name: Project Integrations
    description: Project-scoped integration catalog and configuration
  - name: Integrations
    description: Transitional external integration catalog for first-party clients
  - name: Integration Tools
    description: >-
      Transitional dynamic integration tool listing, invocation, and connection
      state
  - name: OAuth
    description: >-
      Transitional OAuth integration flows for first-party and connected-app
      clients
  - name: Templates
    description: Transitional starter-template discovery used during project creation
  - name: AI
    description: >-
      Transitional platform AI gateway/model helpers; project AI assets use
      project-scoped routes
  - name: Images
    description: Generated images and image assets
  - name: Conversations
    description: Transitional conversation/run-control HTTP surface for first-party clients
  - name: Runs
    description: Transitional hosted run-control endpoints for conversation execution
  - name: MCP
    description: >-
      MCP catalog/playground helpers; primary MCP traffic uses the streamable
      MCP handler
  - name: Logs
    description: Project log queries via Loki
  - name: Metrics
    description: Project metric queries via a Prometheus-compatible backend
  - name: Traces
    description: Project trace queries via Grafana Tempo
  - name: Errors
    description: Internal/public error type catalog (RFC 9457)
  - name: Authentication
    description: Transitional auth token, login, logout, magic-link, and JWKS flows
externalDocs:
  description: Interactive REST reference
  url: https://api.veryfront.com/docs
paths:
  /work:
    get:
      tags:
        - Work
      summary: List account Work definitions
      description: >-
        Lists Work definitions from projects accessible to the current account
        context.
      responses:
        '200':
          description: Account Work definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$
                        name:
                          type: string
                        outcome:
                          type: string
                        agent_id:
                          type: string
                          nullable: true
                        expectations:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              description:
                                type: string
                              optional:
                                type: boolean
                            required:
                              - id
                              - description
                        acceptance_criteria:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              description:
                                type: string
                              optional:
                                type: boolean
                            required:
                              - id
                              - description
                        source_path:
                          type: string
                        edit_mode:
                          type: string
                          enum:
                            - structured
                            - source_only
                        execution_counts:
                          type: object
                          properties:
                            pending:
                              type: integer
                              minimum: 0
                            running:
                              type: integer
                              minimum: 0
                            blocked:
                              type: integer
                              minimum: 0
                            completed:
                              type: integer
                              minimum: 0
                            failed:
                              type: integer
                              minimum: 0
                            cancelled:
                              type: integer
                              minimum: 0
                        updated_at:
                          type: string
                          nullable: true
                        work_schedule:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            project_id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            status:
                              type: string
                              enum:
                                - active
                                - paused
                                - deleting
                            target:
                              type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - task
                                    - workflow
                                    - agent
                                id:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                conversation_mode:
                                  type: string
                                  enum:
                                    - create_new
                                    - existing
                                    - none
                                conversation_id:
                                  type: string
                                  nullable: true
                                  format: uuid
                              required:
                                - kind
                                - id
                              additionalProperties: false
                            schedule:
                              type: string
                            timezone:
                              type: string
                            runtime_target_kind:
                              type: string
                              enum:
                                - main_branch
                                - environment
                                - preview_branch
                            runtime_target_environment_id:
                              type: string
                              nullable: true
                              format: uuid
                            runtime_target_branch_id:
                              type: string
                              nullable: true
                              format: uuid
                            config:
                              type: object
                              additionalProperties:
                                nullable: true
                            timeout_seconds:
                              type: integer
                            backoff_limit:
                              type: integer
                            concurrency_policy:
                              type: string
                            last_scheduled_at:
                              type: string
                              nullable: true
                            last_successful_at:
                              type: string
                              nullable: true
                            max_runs:
                              type: integer
                              nullable: true
                              minimum: 0
                              exclusiveMinimum: true
                            run_count:
                              type: integer
                              minimum: 0
                            completed_at:
                              type: string
                              nullable: true
                            created_by:
                              type: string
                              nullable: true
                              format: uuid
                            run_as_user_id:
                              type: string
                              nullable: true
                              format: uuid
                            created_at:
                              type: string
                            updated_at:
                              type: string
                          required:
                            - id
                            - project_id
                            - name
                            - status
                            - target
                            - schedule
                            - timezone
                            - runtime_target_kind
                            - runtime_target_environment_id
                            - runtime_target_branch_id
                            - config
                            - timeout_seconds
                            - backoff_limit
                            - concurrency_policy
                            - last_scheduled_at
                            - last_successful_at
                            - max_runs
                            - run_count
                            - completed_at
                            - created_by
                            - run_as_user_id
                            - created_at
                            - updated_at
                          additionalProperties: false
                        schedule:
                          type: object
                          nullable: true
                          properties:
                            id:
                              type: string
                              format: uuid
                            project_id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            status:
                              type: string
                              enum:
                                - active
                                - paused
                                - deleting
                            target:
                              type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - task
                                    - workflow
                                    - agent
                                id:
                                  type: string
                                  minLength: 1
                                  maxLength: 255
                                conversation_mode:
                                  type: string
                                  enum:
                                    - create_new
                                    - existing
                                    - none
                                conversation_id:
                                  type: string
                                  nullable: true
                                  format: uuid
                              required:
                                - kind
                                - id
                              additionalProperties: false
                            schedule:
                              type: string
                            timezone:
                              type: string
                            runtime_target_kind:
                              type: string
                              enum:
                                - main_branch
                                - environment
                                - preview_branch
                            runtime_target_environment_id:
                              type: string
                              nullable: true
                              format: uuid
                            runtime_target_branch_id:
                              type: string
                              nullable: true
                              format: uuid
                            config:
                              type: object
                              additionalProperties:
                                nullable: true
                            timeout_seconds:
                              type: integer
                            backoff_limit:
                              type: integer
                            concurrency_policy:
                              type: string
                            last_scheduled_at:
                              type: string
                              nullable: true
                            last_successful_at:
                              type: string
                              nullable: true
                            max_runs:
                              type: integer
                              nullable: true
                              minimum: 0
                              exclusiveMinimum: true
                            run_count:
                              type: integer
                              minimum: 0
                            completed_at:
                              type: string
                              nullable: true
                            created_by:
                              type: string
                              nullable: true
                              format: uuid
                            run_as_user_id:
                              type: string
                              nullable: true
                              format: uuid
                            created_at:
                              type: string
                            updated_at:
                              type: string
                          required:
                            - id
                            - project_id
                            - name
                            - status
                            - target
                            - schedule
                            - timezone
                            - runtime_target_kind
                            - runtime_target_environment_id
                            - runtime_target_branch_id
                            - config
                            - timeout_seconds
                            - backoff_limit
                            - concurrency_policy
                            - last_scheduled_at
                            - last_successful_at
                            - max_runs
                            - run_count
                            - completed_at
                            - created_by
                            - run_as_user_id
                            - created_at
                            - updated_at
                          additionalProperties: false
                        project_id:
                          type: string
                          format: uuid
                        project_name:
                          type: string
                        project_slug:
                          type: string
                      required:
                        - id
                        - name
                        - outcome
                        - expectations
                        - acceptance_criteria
                        - source_path
                        - edit_mode
                        - execution_counts
                        - updated_at
                        - project_id
                        - project_name
                        - project_slug
                required:
                  - data
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  error:
                    type: string
                  message:
                    type: string
                  edit_mode:
                    type: string
                    enum:
                      - structured
                      - source_only
                  source_only_reasons:
                    type: array
                    items:
                      type: string
                  source_path:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: number
                  detail:
                    type: string
                  error:
                    type: string
                  message:
                    type: string
                  edit_mode:
                    type: string
                    enum:
                      - structured
                      - source_only
                  source_only_reasons:
                    type: array
                    items:
                      type: string
                  source_path:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use a JWT bearer token or a Veryfront API key in the Authorization
        header.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative API key header for vf_<prefix>_<secret> tokens.

````