# Outcome Contract routes

URL: /code/api/outcome-contract · Id: `page:code/api/outcome-contract`

> Every Outcome Contract Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for [Outcome Contract](/business/nouns/outcome-contract).

| Noun | System | Run by |
| --- | --- | --- |
| [Outcome Contract](/business/nouns/outcome-contract) | [Service delivery](/systems/service-delivery) | [Delivery Manager](/agents/operations/delivery-manager) |

### OutcomeContract.get
Returns one Outcome Contract by id. [Verb page](/business/nouns/outcome-contract/get?interface=api).

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `outcomeContract` | [Outcome Contract](/business/nouns/outcome-contract) | Yes | The Outcome Contract. |

**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/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/catalogmend.com",
  "$type": "OutcomeContract",
  "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
  "outcomeContract": {
    "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "$type": "OutcomeContract",
    "done": "Order.accepted",
    "accept": "The buyer, within 5 business days of delivery",
    "remedy": "Redo once, then refund in full"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "up": "https://api.sb/catalogmend.com/outcome-contracts"
  }
}
```

### OutcomeContract.list
Returns Outcome Contracts, newest first, one page at a time. [Verb page](/business/nouns/outcome-contract/list?interface=api).

```text
GET /{namespace}/outcome-contracts
```

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 |
| --- | --- | --- | --- |
| `outcomeContracts` | list of [Outcome Contract](/business/nouns/outcome-contract) | Yes | One page of Outcome Contracts. |

**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/catalogmend.com/outcome-contracts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/catalogmend.com",
  "$type": "OutcomeContract",
  "outcomeContracts": [
    {
      "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
      "$type": "OutcomeContract",
      "done": "Order.accepted",
      "accept": "The buyer, within 5 business days of delivery",
      "remedy": "Redo once, then refund in full"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "outcome_goNlouZJ7A"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/outcome-contracts?limit=20",
    "next": "https://api.sb/catalogmend.com/outcome-contracts?after=outcome_goNlouZJ7A"
  }
}
```

### OutcomeContract.update
Changes the given properties of an Outcome Contract. [Verb page](/business/nouns/outcome-contract/update?interface=api).

```text
PATCH /{namespace}/outcome-contracts/{id}
```

Path: `id`. Body, as JSON: the other inputs. Emits `OutcomeContract.updated`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Outcome Contract. |
| `done` | `text` | No | The state or Event that counts as done. |
| `accept` | `text` | No | Who accepts the result, and within what window. |
| `remedy` | `text` | No | What happens on a miss: redo, refund, or credit. |
| `revisions` | `integer` | No | How many times the Customer may send work back before the remedy applies, such as 1. |
| `silence` | `string` | No | What the Customer’s silence means once the acceptance window passes. |
| `earns` | `string` | No | The Event that captures payment and earns the fee. |
| `assurance` | `json` | No | The Evaluators that check done before every delivery, and the share of work a person grades, such as 2%. |
| `window` | `string` | No | How long the Customer has to confirm, revise or dispute each delivery, as an ISO duration. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `outcomeContract` | [Outcome Contract](/business/nouns/outcome-contract) | Yes | The Outcome Contract. |

**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 PATCH https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"done":"Order.accepted"}'
```

```json
{
  "api": "https://api.sb/catalogmend.com",
  "outcomeContract": {
    "$id": "https://api.sb/catalogmend.com/outcome-contracts/outcome_goNlouZJ7A",
    "$type": "OutcomeContract",
    "done": "Order.accepted",
    "accept": "The buyer, within 5 business days of delivery",
    "remedy": "Redo once, then refund in full"
  },
  "action": {
    "$id": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc",
    "operation": "OutcomeContract.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/catalogmend.com/actions/act_ZY4jDpkbtc"
  }
}
```