Skip to main content
POST
/
flows
/
paginate
Paginate Flows
curl --request POST \
  --url https://api.example.com/flows/paginate \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "flows": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "deployment": {
      "operator": "and_",
      "is_null_": true
    },
    "name": {
      "any_": [
        "my-flow-1",
        "my-flow-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    }
  },
  "flow_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-flow-run-1",
        "my-flow-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "deployment_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "operator": "and_",
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": [],
        "not_any_": []
      },
      "name": {
        "any_": [
          "<string>"
        ],
        "not_any_": [
          "<string>"
        ]
      }
    },
    "flow_version": {
      "any_": [
        "<string>"
      ]
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "end_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "next_scheduled_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "parent_flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "parent_task_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": true
    },
    "idempotency_key": {
      "any_": [
        "<string>"
      ],
      "not_any_": [
        "<string>"
      ]
    },
    "created_by": {
      "operator": "and_",
      "id_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "type_": [
        "DEPLOYMENT",
        "AUTOMATION"
      ],
      "is_null_": true
    }
  },
  "task_runs": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-task-run-1",
        "my-task-run-2"
      ],
      "like_": "marvin"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "state": {
      "operator": "and_",
      "type": {
        "any_": []
      },
      "name": {
        "any_": [
          "<string>"
        ]
      }
    },
    "start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "end_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z",
      "is_null_": true
    },
    "expected_start_time": {
      "before_": "2023-11-07T05:31:56Z",
      "after_": "2023-11-07T05:31:56Z"
    },
    "subflow_runs": {
      "exists_": true
    },
    "flow_run_id": {
      "operator": "and_",
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "is_null_": false
    }
  },
  "deployments": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "not_any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "my-deployment-1",
        "my-deployment-2"
      ],
      "like_": "marvin"
    },
    "flow_or_deployment_name": {
      "like_": "<string>"
    },
    "paused": {
      "eq_": true
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    },
    "work_queue_name": {
      "any_": [
        "work_queue_1",
        "work_queue_2"
      ]
    },
    "concurrency_limit": {
      "ge_": 123,
      "le_": 123,
      "is_null_": true
    }
  },
  "work_pools": {
    "operator": "and_",
    "id": {
      "any_": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "name": {
      "any_": [
        "<string>"
      ]
    },
    "type": {
      "any_": [
        "<string>"
      ]
    }
  },
  "sort": "NAME_ASC",
  "limit": 123
}
'
import requests

url = "https://api.example.com/flows/paginate"

payload = {
"page": 1,
"flows": {
"operator": "and_",
"id": {
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"not_any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"deployment": {
"operator": "and_",
"is_null_": True
},
"name": {
"any_": ["my-flow-1", "my-flow-2"],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"is_null_": True
}
},
"flow_runs": {
"operator": "and_",
"id": {
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"not_any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"name": {
"any_": ["my-flow-run-1", "my-flow-run-2"],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"any_": ["tag-1", "tag-2"],
"is_null_": True
},
"deployment_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_null_": True
},
"work_queue_name": {
"operator": "and_",
"any_": ["work_queue_1", "work_queue_2"],
"is_null_": True
},
"state": {
"operator": "and_",
"type": {
"any_": [],
"not_any_": []
},
"name": {
"any_": ["<string>"],
"not_any_": ["<string>"]
}
},
"flow_version": { "any_": ["<string>"] },
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"next_scheduled_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"parent_flow_run_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"parent_task_run_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_null_": True
},
"idempotency_key": {
"any_": ["<string>"],
"not_any_": ["<string>"]
},
"created_by": {
"operator": "and_",
"id_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"type_": ["DEPLOYMENT", "AUTOMATION"],
"is_null_": True
}
},
"task_runs": {
"operator": "and_",
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"name": {
"any_": ["my-task-run-1", "my-task-run-2"],
"like_": "marvin"
},
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"is_null_": True
},
"state": {
"operator": "and_",
"type": { "any_": [] },
"name": { "any_": ["<string>"] }
},
"start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"end_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z",
"is_null_": True
},
"expected_start_time": {
"before_": "2023-11-07T05:31:56Z",
"after_": "2023-11-07T05:31:56Z"
},
"subflow_runs": { "exists_": True },
"flow_run_id": {
"operator": "and_",
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"is_null_": False
}
},
"deployments": {
"operator": "and_",
"id": {
"any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"not_any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
},
"name": {
"any_": ["my-deployment-1", "my-deployment-2"],
"like_": "marvin"
},
"flow_or_deployment_name": { "like_": "<string>" },
"paused": { "eq_": True },
"tags": {
"operator": "and_",
"all_": ["tag-1", "tag-2"],
"any_": ["tag-1", "tag-2"],
"is_null_": True
},
"work_queue_name": { "any_": ["work_queue_1", "work_queue_2"] },
"concurrency_limit": {
"ge_": 123,
"le_": 123,
"is_null_": True
}
},
"work_pools": {
"operator": "and_",
"id": { "any_": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] },
"name": { "any_": ["<string>"] },
"type": { "any_": ["<string>"] }
},
"sort": "NAME_ASC",
"limit": 123
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
flows: {
operator: 'and_',
id: {
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
not_any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
deployment: {operator: 'and_', is_null_: true},
name: {any_: ['my-flow-1', 'my-flow-2'], like_: 'marvin'},
tags: {operator: 'and_', all_: ['tag-1', 'tag-2'], is_null_: true}
},
flow_runs: {
operator: 'and_',
id: {
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
not_any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
name: {any_: ['my-flow-run-1', 'my-flow-run-2'], like_: 'marvin'},
tags: {
operator: 'and_',
all_: ['tag-1', 'tag-2'],
any_: ['tag-1', 'tag-2'],
is_null_: true
},
deployment_id: {
operator: 'and_',
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_null_: true
},
work_queue_name: {operator: 'and_', any_: ['work_queue_1', 'work_queue_2'], is_null_: true},
state: {
operator: 'and_',
type: {any_: [], not_any_: []},
name: {any_: ['<string>'], not_any_: ['<string>']}
},
flow_version: {any_: ['<string>']},
start_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
end_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
expected_start_time: {before_: '2023-11-07T05:31:56Z', after_: '2023-11-07T05:31:56Z'},
next_scheduled_start_time: {before_: '2023-11-07T05:31:56Z', after_: '2023-11-07T05:31:56Z'},
parent_flow_run_id: {operator: 'and_', any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
parent_task_run_id: {
operator: 'and_',
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_null_: true
},
idempotency_key: {any_: ['<string>'], not_any_: ['<string>']},
created_by: {
operator: 'and_',
id_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
type_: ['DEPLOYMENT', 'AUTOMATION'],
is_null_: true
}
},
task_runs: {
operator: 'and_',
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
name: {any_: ['my-task-run-1', 'my-task-run-2'], like_: 'marvin'},
tags: {operator: 'and_', all_: ['tag-1', 'tag-2'], is_null_: true},
state: {operator: 'and_', type: {any_: []}, name: {any_: ['<string>']}},
start_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
end_time: {
before_: '2023-11-07T05:31:56Z',
after_: '2023-11-07T05:31:56Z',
is_null_: true
},
expected_start_time: {before_: '2023-11-07T05:31:56Z', after_: '2023-11-07T05:31:56Z'},
subflow_runs: {exists_: true},
flow_run_id: {
operator: 'and_',
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
is_null_: false
}
},
deployments: {
operator: 'and_',
id: {
any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
not_any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
},
name: {any_: ['my-deployment-1', 'my-deployment-2'], like_: 'marvin'},
flow_or_deployment_name: {like_: '<string>'},
paused: {eq_: true},
tags: {
operator: 'and_',
all_: ['tag-1', 'tag-2'],
any_: ['tag-1', 'tag-2'],
is_null_: true
},
work_queue_name: {any_: ['work_queue_1', 'work_queue_2']},
concurrency_limit: {ge_: 123, le_: 123, is_null_: true}
},
work_pools: {
operator: 'and_',
id: {any_: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']},
name: {any_: ['<string>']},
type: {any_: ['<string>']}
},
sort: 'NAME_ASC',
limit: 123
})
};

fetch('https://api.example.com/flows/paginate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/flows/paginate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'flows' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'not_any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'deployment' => [
'operator' => 'and_',
'is_null_' => true
],
'name' => [
'any_' => [
'my-flow-1',
'my-flow-2'
],
'like_' => 'marvin'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
]
],
'flow_runs' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'not_any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'my-flow-run-1',
'my-flow-run-2'
],
'like_' => 'marvin'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'any_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
],
'deployment_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'is_null_' => true
],
'work_queue_name' => [
'operator' => 'and_',
'any_' => [
'work_queue_1',
'work_queue_2'
],
'is_null_' => true
],
'state' => [
'operator' => 'and_',
'type' => [
'any_' => [

],
'not_any_' => [

]
],
'name' => [
'any_' => [
'<string>'
],
'not_any_' => [
'<string>'
]
]
],
'flow_version' => [
'any_' => [
'<string>'
]
],
'start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'end_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'expected_start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z'
],
'next_scheduled_start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z'
],
'parent_flow_run_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'parent_task_run_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'is_null_' => true
],
'idempotency_key' => [
'any_' => [
'<string>'
],
'not_any_' => [
'<string>'
]
],
'created_by' => [
'operator' => 'and_',
'id_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'type_' => [
'DEPLOYMENT',
'AUTOMATION'
],
'is_null_' => true
]
],
'task_runs' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'my-task-run-1',
'my-task-run-2'
],
'like_' => 'marvin'
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
],
'state' => [
'operator' => 'and_',
'type' => [
'any_' => [

]
],
'name' => [
'any_' => [
'<string>'
]
]
],
'start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'end_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z',
'is_null_' => true
],
'expected_start_time' => [
'before_' => '2023-11-07T05:31:56Z',
'after_' => '2023-11-07T05:31:56Z'
],
'subflow_runs' => [
'exists_' => true
],
'flow_run_id' => [
'operator' => 'and_',
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'is_null_' => false
]
],
'deployments' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'not_any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'my-deployment-1',
'my-deployment-2'
],
'like_' => 'marvin'
],
'flow_or_deployment_name' => [
'like_' => '<string>'
],
'paused' => [
'eq_' => true
],
'tags' => [
'operator' => 'and_',
'all_' => [
'tag-1',
'tag-2'
],
'any_' => [
'tag-1',
'tag-2'
],
'is_null_' => true
],
'work_queue_name' => [
'any_' => [
'work_queue_1',
'work_queue_2'
]
],
'concurrency_limit' => [
'ge_' => 123,
'le_' => 123,
'is_null_' => true
]
],
'work_pools' => [
'operator' => 'and_',
'id' => [
'any_' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'name' => [
'any_' => [
'<string>'
]
],
'type' => [
'any_' => [
'<string>'
]
]
],
'sort' => 'NAME_ASC',
'limit' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.example.com/flows/paginate"

payload := strings.NewReader("{\n \"page\": 1,\n \"flows\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"deployment\": {\n \"operator\": \"and_\",\n \"is_null_\": true\n },\n \"name\": {\n \"any_\": [\n \"my-flow-1\",\n \"my-flow-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"task_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-task-run-1\",\n \"my-task-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"subflow_runs\": {\n \"exists_\": true\n },\n \"flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": false\n }\n },\n \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"work_pools\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\n}")

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

req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/flows/paginate")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"flows\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"deployment\": {\n \"operator\": \"and_\",\n \"is_null_\": true\n },\n \"name\": {\n \"any_\": [\n \"my-flow-1\",\n \"my-flow-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"task_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-task-run-1\",\n \"my-task-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"subflow_runs\": {\n \"exists_\": true\n },\n \"flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": false\n }\n },\n \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"work_pools\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/flows/paginate")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"flows\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"deployment\": {\n \"operator\": \"and_\",\n \"is_null_\": true\n },\n \"name\": {\n \"any_\": [\n \"my-flow-1\",\n \"my-flow-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n }\n },\n \"flow_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-flow-run-1\",\n \"my-flow-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"deployment_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": [],\n \"not_any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n }\n },\n \"flow_version\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"next_scheduled_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"parent_flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"parent_task_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": true\n },\n \"idempotency_key\": {\n \"any_\": [\n \"<string>\"\n ],\n \"not_any_\": [\n \"<string>\"\n ]\n },\n \"created_by\": {\n \"operator\": \"and_\",\n \"id_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"type_\": [\n \"DEPLOYMENT\",\n \"AUTOMATION\"\n ],\n \"is_null_\": true\n }\n },\n \"task_runs\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-task-run-1\",\n \"my-task-run-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"state\": {\n \"operator\": \"and_\",\n \"type\": {\n \"any_\": []\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"end_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\",\n \"is_null_\": true\n },\n \"expected_start_time\": {\n \"before_\": \"2023-11-07T05:31:56Z\",\n \"after_\": \"2023-11-07T05:31:56Z\"\n },\n \"subflow_runs\": {\n \"exists_\": true\n },\n \"flow_run_id\": {\n \"operator\": \"and_\",\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"is_null_\": false\n }\n },\n \"deployments\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"not_any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"my-deployment-1\",\n \"my-deployment-2\"\n ],\n \"like_\": \"marvin\"\n },\n \"flow_or_deployment_name\": {\n \"like_\": \"<string>\"\n },\n \"paused\": {\n \"eq_\": true\n },\n \"tags\": {\n \"operator\": \"and_\",\n \"all_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"any_\": [\n \"tag-1\",\n \"tag-2\"\n ],\n \"is_null_\": true\n },\n \"work_queue_name\": {\n \"any_\": [\n \"work_queue_1\",\n \"work_queue_2\"\n ]\n },\n \"concurrency_limit\": {\n \"ge_\": 123,\n \"le_\": 123,\n \"is_null_\": true\n }\n },\n \"work_pools\": {\n \"operator\": \"and_\",\n \"id\": {\n \"any_\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n },\n \"name\": {\n \"any_\": [\n \"<string>\"\n ]\n },\n \"type\": {\n \"any_\": [\n \"<string>\"\n ]\n }\n },\n \"sort\": \"NAME_ASC\",\n \"limit\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "labels": {
        "key": "value1",
        "key2": 42
      }
    }
  ],
  "count": 123,
  "limit": 123,
  "pages": 123,
  "page": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

x-prefect-api-version
string

Body

application/json
page
integer
default:1
Required range: x >= 1
flows
FlowFilter · object | null

Filter for flows. Only flows matching all criteria will be returned.

flow_runs
FlowRunFilter · object | null

Filter flow runs. Only flow runs matching all criteria will be returned

task_runs
TaskRunFilter · object | null

Filter task runs. Only task runs matching all criteria will be returned

deployments
DeploymentFilter · object | null

Filter for deployments. Only deployments matching all criteria will be returned.

work_pools
WorkPoolFilter · object | null

Filter work pools. Only work pools matching all criteria will be returned

sort
enum<string>
default:NAME_ASC

Defines flow sorting options.

Available options:
CREATED_DESC,
UPDATED_DESC,
NAME_ASC,
NAME_DESC
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

Successful Response

results
Flow · object[]
required
count
integer
required
limit
integer
required
pages
integer
required
page
integer
required