---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads

`GET /v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads`

## Request

- Base URL: `https://composer.googleapis.com`
- URL: `https://composer.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads`
- Auth: one of:
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloud-platform`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloudcomposer`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloudcomposer`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloudcomposer.readonly`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloudcomposer.readonly`
- TypeScript: <https://skmtc.dev/google/apis/composer/docs/v1/projects/:projectsId/locations/:locationsId/environments/:environmentsId/workloads/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required
- `environmentsId` string, required

## Query parameters

- `filter` string
- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- ListWorkloadsResponse: Response to ListWorkloadsRequest.
  - `nextPageToken` string: The page token used to query for the next page if one exists.
  - `workloads` ComposerWorkload[]: The list of environment workloads.
    - `name` string: Name of a workload.
    - `status` ComposerWorkloadStatus: Workload status.
      - `detailedStatusMessage` string: Output only. Detailed message of the status.
      - `state` 'COMPOSER_WORKLOAD_STATE_UNSPECIFIED' | 'PENDING' | 'OK' | 'WARNING' | 'ERROR' | 'SUCCEEDED' | 'FAILED': Output only. Workload state.
      - `statusMessage` string: Output only. Text to provide more descriptive status.
    - `type` 'COMPOSER_WORKLOAD_TYPE_UNSPECIFIED' | 'CELERY_WORKER' | 'KUBERNETES_WORKER' | 'KUBERNETES_OPERATOR_POD' | 'SCHEDULER' | 'DAG_PROCESSOR' | 'TRIGGERER' | 'WEB_SERVER' | 'REDIS': Type of a workload.

## Changes

- **2026-11-07** `9c23b974ddbb`: 4 info
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/cloudcomposer.readonly` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloudcomposer.readonly` was removed from the endpoint's security scheme `Oauth2c`

[Operation history](https://skmtc.dev/google/apis/composer/changes/v1/projects/:projectsId/locations/:locationsId/environments/:environmentsId/workloads/get.md)

---

[API](https://skmtc.dev/google/apis/composer.md) - [All operations](https://skmtc.dev/google/apis/composer/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/composer/revisions/9c23b974ddbb?raw)
