# Opening routes: create, get, list

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

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

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

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

```text
POST /{namespace}/openings
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `role` | [Role](/business/nouns/role) | Yes | The Role the Human joins, by taking a share of it. |
| `kind` | `string` | Yes | One of `floor`, `contractor`, `employee`, or `cofounder`. |
| `reason` | `string` | Yes | One of `floor`, `credential`, `edge`, `relationship`, `capital`, `capacity`, or `distribution`. |
| `hypothesis` | [Hypothesis](/business/nouns/hypothesis) | Yes | The result a hire must beat the incumbent Agent on. |
| `skills` | list of [Skill](/business/nouns/skill) | No | The Skills required, each citing the Evidence that shows the gap. |
| `credentials` | list of [Credential](/business/nouns/credential) | No | The Credentials a Reserved Act in the Role requires. |
| `commitment` | `string` | No | Hours per week, from a few hours to full time. |
| `terms` | `url` | No | The published terms for this kind of Opening. |
| `listed` | `boolean` | No | True once the Opening is public; unlisted Openings reach only the talent pool. |

**Returns**

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

**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/openings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"role_oloMFMUeCH","kind":"floor","reason":"floor","hypothesis":"hypothesis_Z1gjx1kbtc"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "opening": {
    "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "$type": "Opening",
    "role": "role_oloMFMUeCH",
    "kind": "floor",
    "reason": "floor",
    "hypothesis": "hypothesis_Z1gjx1kbtc"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Opening.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Opening",
  "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
  "opening": {
    "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "$type": "Opening",
    "role": "role_oloMFMUeCH",
    "kind": "floor",
    "reason": "floor",
    "hypothesis": "hypothesis_Z1gjx1kbtc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
    "up": "https://api.sb/leaseline.app/openings"
  }
}
```

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

```text
GET /{namespace}/openings
```

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 |
| --- | --- | --- | --- |
| `openings` | list of [Opening](/business/nouns/opening) | Yes | One page of Openings. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Opening",
  "openings": [
    {
      "$id": "https://api.sb/leaseline.app/openings/opening_3rD8qFSOyQ",
      "$type": "Opening",
      "role": "role_oloMFMUeCH",
      "kind": "floor",
      "reason": "floor",
      "hypothesis": "hypothesis_Z1gjx1kbtc"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "opening_3rD8qFSOyQ"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/openings?limit=20",
    "next": "https://api.sb/leaseline.app/openings?after=opening_3rD8qFSOyQ"
  }
}
```