# Agreement routes: create, get, list

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

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

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

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

```text
POST /{namespace}/agreements
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `term` | `text` | No | How long it runs and how it ends. |
| `signedAt` | `datetime` | No | When the last Party signed. |
| `terminatedAt` | `datetime` | No | When it ended under its term; it stays on record. |
| `payoutSchedule` | `string` | No | For a Supplier’s Agreement: how often the released earned balance pays out. |
| `clearanceDays` | `integer` | No | For a Supplier’s Agreement: days an Order’s earnings wait after confirmation before they can pay out. |

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Agreement.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agreement",
  "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
  "agreement": {
    "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "$type": "Agreement",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
    "up": "https://api.sb/leaseline.app/agreements"
  },
  "actions": {
    "sign": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/sign",
    "terminate": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY/terminate"
  }
}
```

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

```text
GET /{namespace}/agreements
```

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 |
| --- | --- | --- | --- |
| `agreements` | list of [Agreement](/business/nouns/agreement) | Yes | One page of Agreements. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Agreement",
  "agreements": [
    {
      "$id": "https://api.sb/leaseline.app/agreements/agreement_zHIUnX8LwY",
      "$type": "Agreement",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "agreement_zHIUnX8LwY"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/agreements?limit=20",
    "next": "https://api.sb/leaseline.app/agreements?after=agreement_zHIUnX8LwY"
  }
}
```