# Relationship routes: create, get, list

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

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

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

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

```text
POST /{namespace}/relationships
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `predicate` | `string` | Yes | The name read from the source, such as `makes`. |
| `inverse` | `string` | Yes | The name read from the target, such as `madeBy`. |
| `provenance` | `string` | No | Who asserted it: `Stated`, `Ratified`, `Inferred`, or `Observed`. |
| `verb` | [Verb](/business/nouns/verb) | No | A Relationship reads through a Verb whose forms name it from each side, such as `makes` and `madeBy`. |

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "relationship": {
    "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "$type": "Relationship",
    "predicate": "Example predicate",
    "inverse": "Example inverse"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Relationship.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Relationship",
  "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
  "relationship": {
    "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "$type": "Relationship",
    "predicate": "Example predicate",
    "inverse": "Example inverse"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
    "up": "https://api.sb/leaseline.app/relationships"
  }
}
```

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

```text
GET /{namespace}/relationships
```

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 |
| --- | --- | --- | --- |
| `relationships` | list of [Relationship](/business/nouns/relationship) | Yes | One page of Relationships. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Relationship",
  "relationships": [
    {
      "$id": "https://api.sb/leaseline.app/relationships/relationship_iUVcHztTJh",
      "$type": "Relationship",
      "predicate": "Example predicate",
      "inverse": "Example inverse"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "relationship_iUVcHztTJh"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/relationships?limit=20",
    "next": "https://api.sb/leaseline.app/relationships?after=relationship_iUVcHztTJh"
  }
}
```