> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/switch-infrastructure/config-manager/_mcp/server.

# Get Workflows

GET /v1/workflow/

Return a filtered list of workflows.

Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/switch-infrastructure/config-manager/services/temporal/temporal-api/workflow/get-workflows-v-1-workflow-get

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: temporal-api
  version: 1.0.0
paths:
  /v1/workflow/:
    get:
      operationId: get_workflows_v1_workflow__get
      summary: Get Workflows
      description: Return a filtered list of workflows.
      tags:
        - workflow
      parameters:
        - name: user
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: workflow_type
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: workflow_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: device_id
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: device_name
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: device_role
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: device_platform
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: site
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: status
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: pending_approval
          in: query
          required: false
          schema:
            type:
              - boolean
              - 'null'
        - name: start_time
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: end_time
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
            format: date-time
        - name: hide_completed
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
        - name: next_page_token
          in: query
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: Authorization
          in: header
          description: >-
            Bearer JWT used by CLI and machine clients on svc-* endpoints.
            Authentication is required by default, but deployments may disable
            it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE
            identities, and trusted gateway identity headers may also satisfy
            authentication outside this generated client flow.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WorkflowSummaryResponseSearchAttributes:
      oneOf:
        - type: array
          items:
            type: string
        - type: array
          items:
            type: integer
        - type: array
          items:
            type: number
            format: double
        - type: array
          items:
            type: boolean
        - type: array
          items:
            type: string
            format: date-time
      title: WorkflowSummaryResponseSearchAttributes
    WorkflowSummaryResponse:
      type: object
      properties:
        close_time:
          type:
            - string
            - 'null'
          format: date-time
        failed_stage:
          type: boolean
        href:
          type: string
          description: Calculate URL to Temporal UI Workflow View.
        id:
          type: string
        pending_approval:
          type: boolean
        search_attributes:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/WorkflowSummaryResponseSearchAttributes'
        start_time:
          type: string
          format: date-time
        started_by:
          type: string
        status:
          type: string
        workflow_input:
          description: Any type
        workflow_type:
          type: string
      required:
        - close_time
        - failed_stage
        - href
        - id
        - pending_approval
        - search_attributes
        - start_time
        - started_by
        - status
        - workflow_input
        - workflow_type
      description: Workflow Summary Response for use in List API.
      title: WorkflowSummaryResponse
    WorkflowListResponse:
      type: object
      properties:
        next_page_token:
          type:
            - string
            - 'null'
        page_count:
          type: integer
        total_count:
          type: integer
        workflows:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowSummaryResponse'
      required:
        - next_page_token
        - page_count
        - total_count
        - workflows
      description: Workflow List Response Model.
      title: WorkflowListResponse
    ValidationErrorCtx:
      type: object
      properties: {}
      title: ValidationErrorCtx
    ValidationErrorLocItems:
      oneOf:
        - type: string
        - type: integer
      title: ValidationErrorLocItems
    ValidationError:
      type: object
      properties:
        ctx:
          $ref: '#/components/schemas/ValidationErrorCtx'
        input:
          description: Any type
        loc:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
    HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
      title: HTTPValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer JWT used by CLI and machine clients on svc-* endpoints.
        Authentication is required by default, but deployments may disable it
        with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE
        identities, and trusted gateway identity headers may also satisfy
        authentication outside this generated client flow.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "next_page_token": "eyJwYWdlIjoxfQ==",
  "page_count": 1,
  "total_count": 1,
  "workflows": [
    {
      "close_time": "2024-01-15T09:30:00Z",
      "failed_stage": false,
      "href": "https://temporal.example.com/workflow/view/3f2504e0-4f89-11d3-9a0c-0305e82c3301",
      "id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
      "pending_approval": false,
      "search_attributes": {
        "DeviceId": [
          "device-1234"
        ],
        "IsCritical": [
          true
        ],
        "Priority": [
          2
        ],
        "StartDates": [
          "2024-01-10T08:00:00Z"
        ]
      },
      "start_time": "2024-01-10T08:00:00Z",
      "started_by": "alice@example.com",
      "status": "Running",
      "workflow_input": {
        "parameters": {
          "dataset": "sales_2023",
          "retry": 3
        },
        "task": "data_processing"
      },
      "workflow_type": "DataProcessingWorkflow"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.example.com/v1/workflow/"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/v1/workflow/';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/workflow/"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/workflow/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflow/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/v1/workflow/', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/v1/workflow/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/workflow/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```