---
search:
  exclude: true
---

# <a id="bitdrift.public.unary.workflows.v1.ListWorkflowsRequest"></a>ListWorkflowsRequest

| Field | Type | Description |
|---|---|---|
| offset | <span class="proto-type proto-type-primitive">optional uint32</span> | Used to paginate through results. To get the next page result, set this to  the desired starting offset. For example, setting to 10 will start with the  10th record. The default value is 0. |
| limit | <span class="proto-type proto-type-primitive">optional uint32</span> | This defines the upper bound of the number of items returned. The maximum  value supported is 100, meaning that we’ll never return more than  max(items.count, limit, 100). |
| filters | <span class="proto-type proto-type-message">repeated [<i class="proto-type-part">bitdrift</i><i class="proto-type-dot">.</i><i class="proto-type-part">public</i><i class="proto-type-dot">.</i><i class="proto-type-part">unary</i><i class="proto-type-dot">.</i><i class="proto-type-part">workflows</i><i class="proto-type-dot">.</i><i class="proto-type-part">v1</i><i class="proto-type-dot">.</i><i class="proto-type-part">Filter</i>](bitdrift_public_unary_workflows_v1_Filter.md#bitdrift.public.unary.workflows.v1.Filter){ title="bitdrift.public.unary.workflows.v1.Filter"}</span> | Filter the list of workflows based on the current user's relationship to  the workflow. This is a logical OR. If no filters are supplied, all  workflows are returned. |
| platform_targets | <span class="proto-type proto-type-message">repeated [<i class="proto-type-part">bitdrift</i><i class="proto-type-dot">.</i><i class="proto-type-part">public</i><i class="proto-type-dot">.</i><i class="proto-type-part">shared</i><i class="proto-type-dot">.</i><i class="proto-type-part">platform</i><i class="proto-type-dot">.</i><i class="proto-type-part">v1</i><i class="proto-type-dot">.</i><i class="proto-type-part">Platform</i>](bitdrift_public_shared_platform_v1_Platform.md#bitdrift.public.shared.platform.v1.Platform){ title="bitdrift.public.shared.platform.v1.Platform"}</span> | Filter the list of workflows based on the platform(s) that that workflow  targets. This is a logical OR. If no platforms are supplied, all workflows are returned. |
| sort | <span class="proto-type proto-type-message">repeated [<i class="proto-type-part">bitdrift</i><i class="proto-type-dot">.</i><i class="proto-type-part">public</i><i class="proto-type-dot">.</i><i class="proto-type-part">unary</i><i class="proto-type-dot">.</i><i class="proto-type-part">workflows</i><i class="proto-type-dot">.</i><i class="proto-type-part">v1</i><i class="proto-type-dot">.</i><i class="proto-type-part">ListWorkflowsRequest</i><i class="proto-type-dot">.</i><i class="proto-type-part">Sort</i>](#bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort){ title="bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort"}</span> | Orders workflows by caller-visible attributes. Apply criteria in the order provided. |

#### Example
```json
{
  "filters": [
    {
      "owned": {}
    }
  ],
  "limit": 25,
  "offset": 1,
  "platform_targets": [
    {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    }
  ],
  "sort": [
    {
      "direction": "DESCENDING",
      "key": "CREATION_TIME"
    }
  ]
}
```

# <a id="bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort"></a>ListWorkflowsRequest.Sort

| Field | Type | Description |
|---|---|---|
| key | <span class="proto-type proto-type-enum">[<i class="proto-type-part">bitdrift</i><i class="proto-type-dot">.</i><i class="proto-type-part">public</i><i class="proto-type-dot">.</i><i class="proto-type-part">unary</i><i class="proto-type-dot">.</i><i class="proto-type-part">workflows</i><i class="proto-type-dot">.</i><i class="proto-type-part">v1</i><i class="proto-type-dot">.</i><i class="proto-type-part">ListWorkflowsRequest</i><i class="proto-type-dot">.</i><i class="proto-type-part">Sort</i><i class="proto-type-dot">.</i><i class="proto-type-part">SortKey</i>](#bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort.SortKey){ title="bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort.SortKey"}</span> | Selects which caller-visible workflow attribute to order by. |
| direction | <span class="proto-type proto-type-enum">[<i class="proto-type-part">bitdrift</i><i class="proto-type-dot">.</i><i class="proto-type-part">public</i><i class="proto-type-dot">.</i><i class="proto-type-part">unary</i><i class="proto-type-dot">.</i><i class="proto-type-part">common</i><i class="proto-type-dot">.</i><i class="proto-type-part">v1</i><i class="proto-type-dot">.</i><i class="proto-type-part">SortDirection</i>](bitdrift_public_unary_common_v1_SortDirection.md#bitdrift.public.unary.common.v1.SortDirection){ title="bitdrift.public.unary.common.v1.SortDirection"}</span> | Selects whether results are returned in ascending or descending order. |

#### Example
```json
{
  "direction": "DESCENDING",
  "key": "CREATION_TIME"
}
```

# <a id="bitdrift.public.unary.workflows.v1.ListWorkflowsRequest.Sort.SortKey"></a>ListWorkflowsRequest.Sort.SortKey

| Name | Number | Description |
|---|---|---|
| SORT_KEY_UNSPECIFIED | 0 |  |
| DISPLAY_NAME | 1 |  |
| CREATION_TIME | 2 |  |
| STATUS | 3 |  |
| OWNER_NAME | 4 |  |
| FAVORITED | 5 |  |

