# Mapping routes: create, get, list

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

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

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

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

```text
POST /{namespace}/mappings
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `verb` | `string` | No | The Verb it serves, such as `Meeting.book`; a Verb has many Mappings, ranked. |
| `fields` | `json` | No | Each outside field or event and the Noun property or Event it maps to. |
| `direction` | `string` | No | `both` still keeps db.sb the record; the outside tool never becomes a second one. |
| `convert` | `text` | No | How a value changes on the way, such as cents to money or a picklist to closed values. |
| `rank` | `integer` | No | Order tried when the preferred Mapping fails or finds nothing; the Policy orders it by cost per accepted result. |
| `preferred` | `boolean` | No | True for the Mapping a Verb tries first. |
| `door` | `string` | No | How the outside endpoint is classed; an unclassed write is one-way and waits its delay window. |
| `source` | [Source](/business/nouns/source) | No | A Source reaches the registry’s Nouns and Verbs through its Mappings, one per Verb it serves. |

**Returns**

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

**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/ratebook.dev/mappings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"verb":"Meeting.book"}'
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "mapping": {
    "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "$type": "Mapping",
    "verb": "Meeting.book",
    "fields": {}
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Mapping.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}
```

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

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

**Returns**

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

**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/ratebook.dev/mappings/mapping_WOromrQi6J \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Mapping",
  "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
  "mapping": {
    "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "$type": "Mapping",
    "verb": "Meeting.book",
    "fields": {}
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
    "up": "https://api.sb/ratebook.dev/mappings"
  }
}
```

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

```text
GET /{namespace}/mappings
```

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 |
| --- | --- | --- | --- |
| `mappings` | list of [Mapping](/business/nouns/mapping) | Yes | One page of Mappings. |

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

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Mapping",
  "mappings": [
    {
      "$id": "https://api.sb/ratebook.dev/mappings/mapping_WOromrQi6J",
      "$type": "Mapping",
      "verb": "Meeting.book",
      "fields": {}
    }
  ],
  "meta": {
    "limit": 20,
    "after": "mapping_WOromrQi6J"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/mappings?limit=20",
    "next": "https://api.sb/ratebook.dev/mappings?after=mapping_WOromrQi6J"
  }
}
```