OneflowList contracts
Lists Oneflow contracts, filtered by workspace, state, template or free text.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Oneflow connection the step signs in with. |
| Workspaces | Comma-separated Oneflow workspace ids. Leave empty for every workspace you can see. |
| States | Comma-separated: draft, pending, signed, declined. |
templateIds | text |
| Search | Free text over the contract's name and content, at most 300 characters. |
| Sort by | text |
| Contracts per call | 1 to 100 — Oneflow's maximum. With Fetch every page on, this is the page size. |
| Offset | How many contracts to pass over first. Oneflow stops at 19,900 — past that, narrow the search with a filter instead. |
| Fetch every page | Pages with offset until Oneflow runs out, and refuses past 5,000 contracts rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `oneflow`) |
workspaceIds | text |
states | text |
templateIds | text |
search | text |
sort | text, by default "published_time" |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
contracts | array |
contractCountContracts in this answer | number |
totalCountHow many Oneflow holds in total | number |
hasMoreMore contracts are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- contractCount0
- contracts[]
- hasMorefalse
- totalCount0
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"cursor": "",
"limit": 100,
"offset": 0,
"returnAll": false,
"search": "",
"sort": "published_time",
"states": "",
"templateIds": "",
"workspaceIds": ""
},
"label": "List contracts",
"type": "oneflow.listContracts",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Oneflow connection the step signs in with. |
| Workspaces | Comma-separated Oneflow workspace ids. Leave empty for every workspace you can see. |
| States | Comma-separated: draft, pending, signed, declined. |
templateIds | text |
| Search | Free text over the contract's name and content, at most 300 characters. |
| Sort by | text |
| Contracts per call | 1 to 100 — Oneflow's maximum. With Fetch every page on, this is the page size. |
| Offset | How many contracts to pass over first. Oneflow stops at 19,900 — past that, narrow the search with a filter instead. |
| Fetch every page | Pages with offset until Oneflow runs out, and refuses past 5,000 contracts rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `oneflow`) |
workspaceIds | text |
states | text |
templateIds | text |
search | text |
sort | text, by default "published_time" |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |