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

# List Workforce

> List workforce components on a branch revision.



## OpenAPI

````yaml GET /orgs/{org_id}/projects/{project_id}/workforce
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: analytics
    description: Project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/projects/{project_id}/workforce:
    get:
      tags:
        - projects
      description: List workforce components on a branch revision.
      operationId: handler
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: project_id
          in: path
          required: true
          schema:
            type: string
        - name: rev
          in: query
          description: Git branch name (for example `main`).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of workforce items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkforceResBody'
      security:
        - bearer_auth: []
components:
  schemas:
    ListWorkforceResBody:
      type: object
      description: >-
        Workforce components on the git branch given by `rev`. The `url` field
        is set only when the component has a **running** deployment for that
        branch.
      required:
        - workforce
      properties:
        workforce:
          type: array
          items:
            $ref: '#/components/schemas/WorkforcePreview'
    WorkforcePreview:
      type: object
      required:
        - id
        - type
        - name
      properties:
        deleted_at:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            Set when the workforce component has been deleted. Only returned
            from endpoints that include soft-deleted rows (e.g. runs list).
        description:
          type:
            - string
            - 'null'
          description: Optional short description.
        id:
          type: string
          description: Identifier of this workforce component within the project.
        name:
          type: string
          description: Display name of the component.
        type:
          $ref: '#/components/schemas/AppType'
          description: Component category (for example agent or workflow).
        uid:
          type:
            - string
            - 'null'
          description: >-
            Stable identifier from the project manifest (`timbal.yaml`), when
            defined.
        url:
          type:
            - string
            - 'null'
          description: >-
            When present, the authenticated Timbal API URL used to call this
            component’s **running** deployment (for example from the
            list-workforce response). Omitted where the response does not expose
            a callable URL, such as on project detail.
    AppType:
      type: string
      description: >-
        Read/output enum for a workforce component's type.


        Tolerant on deserialization (`#[serde(other)]`) because this type is
        reconstructed

        from DB rows via two paths that both must not fail on unknown values:
          1. [`AppType::try_from`] — used by `FromRow` impls reading `OrgsApps.type` directly.
          2. `serde_json::from_value` — used by handlers that build workforce JSON via
             `json_build_object('type', oa.type, ...)` (runs list, deployments, etc.) and
             then deserialize into `WorkforcePreview` / `RunPreview`.

        New workforce types written by `on_push` (or older ones removed from
        this enum) must

        not break list/get endpoints, hence `Unknown` as a catch-all.


        **Do not use this for API request bodies** — see [`AppTypeInput`] for
        the strict

        input variant that rejects unknowns at the deserialization boundary.
      enum:
        - agent
        - workflow
        - unknown
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````