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

# Get Workflow

> Gets details about a specific workflow.

`Unary` · [`Workflows`](https://ona.com/docs/api-reference/generated/workflow/overview)

Gets details about a specific workflow.

Use this method to:

* View workflow configuration
* Check workflow status
* Get workflow metadata

### Examples

* Get workflow details:

  Retrieves information about a specific workflow.

  ```yaml theme={null}
  workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.WorkflowService/GetWorkflow
```

Send a Bearer token as described in [Authentication](https://ona.com/docs/api-reference.md#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

```bash cURL theme={null}
export ONA_HOST=https://app.ona.com
export ONA_API_KEY=<your-token>

curl --request POST \
  --url "$ONA_HOST/api/gitpod.v1.WorkflowService/GetWorkflow" \
  --header "Authorization: Bearer $ONA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "workflowId": "<workflow-id>"
}'
```

```python Python theme={null}
import gitpod.v1.workflow_pb2 as workflow_pb2
from ona_sdk import create_client_from_env

ona = create_client_from_env()
request = workflow_pb2.GetWorkflowRequest(
    workflow_id="<workflow-id>",
)
response = ona.services.workflow.get_workflow(request)
print(response)
```

```typescript TypeScript theme={null}
import { create } from "@bufbuild/protobuf";
import { createClientFromEnv } from "@gitpod/sdk";
import { GetWorkflowRequestSchema } from "@gitpod/sdk/gitpod/v1/workflow_pb";

async function main() {
  const ona = createClientFromEnv();
  const request = create(GetWorkflowRequestSchema, {
    workflowId: "<workflow-id>",
  });
  const response = await ona.services.workflow.getWorkflow(request);
  console.log(response);
}

main().catch(console.error);
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"
	"log"

	"connectrpc.com/connect"
	"github.com/gitpod-io/gitpod-sdk-go/sdk"
	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
)

func main() {
	ona, err := sdk.NewFromEnv()
	if err != nil {
		log.Fatal(err)
	}

	request := connect.NewRequest(&gitpodpb.GetWorkflowRequest{
		WorkflowId: "<workflow-id>",
	})
	response, err := ona.Services.Workflow.GetWorkflow(context.Background(), request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Msg)
}
```

```json Request body theme={null}
{
  "workflowId": "<workflow-id>"
}
```

## Request

`gitpod.v1.GetWorkflowRequest`

GetWorkflowRequest gets details about a specific workflow.

| Field | Type | Required | Description |
| - | - | - | - |
| `workflowId` | string | No | Constraints: `string.uuid=true`. |

## Response

`gitpod.v1.GetWorkflowResponse`

| Field | Type | Required | Description |
| - | - | - | - |
| `workflow` | [Workflow](#type-gitpod-v1-workflow) | No | |

## Related types

> [accordion] Workflow
>
> Workflow represents a workflow configuration.
>
> `gitpod.v1.Workflow`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `id` | string | No | Constraints: `string.uuid=true`. |
> | `metadata` | [Metadata](#type-gitpod-v1-workflow-metadata) | No | |
> | `spec` | [Spec](#type-gitpod-v1-workflow-spec) | No | |
> | `webhookUrl` | string | No | Webhook URL for triggering this workflow via HTTP POST Format: \{base\_url}/workflows/\{workflow\_id}/webhooks |

> [accordion] Metadata
>
> WorkflowMetadata contains workflow metadata.
>
> `gitpod.v1.Workflow.Metadata`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `name` | string | No | Constraints: `string.max_len=80, string.min_len=1`. |
> | `description` | string | No | Constraints: `string.max_len=500`. |
> | `creator` | Subject | No | |
> | `executor` | Subject | No | |
> | `createdAt` | RFC 3339 timestamp | No | |
> | `updatedAt` | RFC 3339 timestamp | No | |

> [accordion] Spec
>
> `gitpod.v1.Workflow.Spec`
>
> | Field | Type | Required | Description |
> | - | - | - | - |
> | `triggers` | array of WorkflowTrigger | No | |
> | `action` | WorkflowAction | No | |
> | `report` | WorkflowAction | No | |
> | `deleting` | boolean | No | Marks workflow as pending deletion |
> | `disabled` | boolean | No | When true, the workflow will not be triggered by any automatic trigger (cron, webhook, pull request). Manual starts via StartWorkflow are also rejected while disabled. |
> | `agentId` | string | No | Agent that runs this workflow. When empty, the agent is resolved at run time (defaults to the Ona agent), preserving behavior for workflows created before agent selection existed. |
> | `codexSettings` | CodexSettings | No | Codex app agent settings (model, reasoning effort, service tier). Only meaningful when agent\_id refers to the Codex app agent. |


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