View as Markdown

ListWorkflowsRequest

Field	Type	Description
offset	optional uint32	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	optional uint32	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	repeated bitdrift.public.unary.explorations.v1.Filter	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.
sort_by	repeated bitdrift.public.unary.common.v1.Sort	Sort the list of workflows based on the given list of fields. The order of the fields in this list determines the order in which sort is applied.
platform_targets	repeated bitdrift.public.shared.platform.v1.Platform	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.

Example

JSON

{
  "filters": [
    {
      "owned": {}
    }
  ],
  "limit": 25,
  "offset": 1,
  "platform_targets": [
    {
      "apple": {
        "apps": [
          {
            "app_id": "com.example.app"
          }
        ]
      }
    }
  ],
  "sort_by": [
    {
      "direction": "ASC",
      "field": "field_name"
    }
  ]
}