# Approval routes: create, get, list

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

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

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

### Approval.create
Creates an Approval. [Verb page](/business/nouns/approval/create?interface=api).

```text
POST /{namespace}/approvals
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `by` | [Worker](/business/nouns/worker) | No | The Worker that performed it. |
| `for` | [Party](/business/nouns/party) | No | The Party it was done on behalf of. |
| `via` | `string` | No | The Interface or request it arrived through. |
| `on` | `string` | No | The Action or Event that caused it, such as the failed attempt a retry follows. |
| `thing` | `string` | No | The record, at the Version the Action was decided against. |
| `input` | `json` | No | The input it was called with. |
| `createdAt` | `datetime` | No | When it was called. |
| `reserved` | `money` | No | The most this Action may cost, held against its Limits from the check until it settles, billed misses included. |
| `due` | `datetime` | No | When the Task is due. |
| `priority` | `integer` | No | Its rank in the inbox, highest first. |
| `recurrence` | `string` | No | The schedule a recurring duty repeats on. |
| `verdict` | `string` | No | One of `allowed` or `refused`. |
| `deadline` | `datetime` | No | When an unanswered Approval cancels the Action. |
| `action` | [Action](/business/nouns/action) | No | An Approval holds one pending Action that exceeds a Limit or Mandate until someone allows or refuses it. |

**Returns**

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

**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/approvals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"by":"worker_whZFpOKWIV"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "approval": {
    "$id": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
    "$type": "Approval",
    "status": "pending",
    "mode": "try"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Approval.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

```text
GET /{namespace}/approvals/{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 Approval. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

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

**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/approvals/approval_TlxQeWh9uX \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Approval",
  "$id": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
  "approval": {
    "$id": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
    "$type": "Approval",
    "status": "pending",
    "mode": "try"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
    "up": "https://api.sb/leaseline.app/approvals"
  },
  "actions": {
    "approve": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX/approve",
    "refuse": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX/refuse"
  }
}
```

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

```text
GET /{namespace}/approvals
```

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 |
| --- | --- | --- | --- |
| `approvals` | list of [Approval](/business/nouns/approval) | Yes | One page of Approvals. |

**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/approvals?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Approval",
  "approvals": [
    {
      "$id": "https://api.sb/leaseline.app/approvals/approval_TlxQeWh9uX",
      "$type": "Approval",
      "status": "pending",
      "mode": "try"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "approval_TlxQeWh9uX"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/approvals?limit=20",
    "next": "https://api.sb/leaseline.app/approvals?after=approval_TlxQeWh9uX"
  }
}
```