# Workflow routes: create, get, list

URL: /code/api/workflow/records · Id: `page:code/api/workflow/records`

> The Workflow Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for [Workflow](/business/nouns/workflow), one group of [Workflow routes](/code/api/workflow).

### Workflow.create
Creates a Workflow. [Verb page](/business/nouns/workflow/create?interface=api).

```text
POST /{namespace}/workflows
```

Body, as JSON: the inputs. Emits `Workflow.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `steps` | `json` | Yes | The ordered steps, each run by a Function. |
| `retries` | `integer` | No | How many times a failed step retries. |
| `body` | `string` | No | The Verb whose Action it is the durable body of, such as `Order.refund`; a Workflow with a body has no Trigger. |
| `process` | [Process](/business/nouns/process) | No | A Process does its work through Workflows, each the durable, executable part of the Process. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `workflow` | [Workflow](/business/nouns/workflow) | Yes | The Workflow. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/workflows \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "workflow": {
    "$id": "https://api.sb/leaseline.app/workflows/workflow_4reEHI1SG4",
    "$type": "Workflow",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Workflow.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Workflow.get
Returns one Workflow by id. [Verb page](/business/nouns/workflow/get?interface=api).

```text
GET /{namespace}/workflows/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Workflow. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `workflow` | [Workflow](/business/nouns/workflow) | Yes | The Workflow. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Workflow",
  "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
  "workflow": {
    "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
    "$type": "Workflow",
    "steps": [
      {
        "do": "Lease.list",
        "where": "endsOn is 60 days away"
      },
      {
        "do": "Lease.notify"
      },
      {
        "do": "Message.create",
        "medium": "email"
      }
    ]
  },
  "links": {
    "self": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
    "up": "https://api.sb/leaseline.app/workflows"
  }
}
```

### Workflow.list
Returns Workflows, newest first, one page at a time. [Verb page](/business/nouns/workflow/list?interface=api).

```text
GET /{namespace}/workflows
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `workflows` | list of [Workflow](/business/nouns/workflow) | Yes | One page of Workflows. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/workflows?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Workflow",
  "workflows": [
    {
      "$id": "https://api.sb/leaseline.app/workflows/workflow_2dhYBlEno0",
      "$type": "Workflow",
      "steps": [
        {
          "do": "Lease.list",
          "where": "endsOn is 60 days away"
        },
        {
          "do": "Lease.notify"
        },
        {
          "do": "Message.create",
          "medium": "email"
        }
      ]
    }
  ],
  "meta": {
    "limit": 20,
    "after": "workflow_2dhYBlEno0"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/workflows?limit=20",
    "next": "https://api.sb/leaseline.app/workflows?after=workflow_2dhYBlEno0"
  }
}
```