# Handle routes: create, get, list

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

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

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

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

```text
POST /{namespace}/handles
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `venue` | `string` | Yes | The venue it lives on, by id. |
| `name` | `string` | Yes | The name as the platform shows it, such as `@example`. |
| `shared` | `boolean` | No | True for a Studio account shared across sibling Startups; every Post names the Startup it speaks for. |
| `agent` | `boolean` | No | True when an Agent runs it; its bio says so. |
| `integration` | [Integration](/business/nouns/integration) | No | The Integration credential it publishes through. |

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "handle": {
    "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "$type": "Handle",
    "venue": "Example venue",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Handle.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

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

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

**Returns**

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

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Handle",
  "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
  "handle": {
    "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "$type": "Handle",
    "venue": "Example venue",
    "name": "Leaseline"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
    "up": "https://api.sb/leaseline.app/handles"
  },
  "actions": {
    "connect": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc/connect"
  }
}
```

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

```text
GET /{namespace}/handles
```

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 |
| --- | --- | --- | --- |
| `handles` | list of [Handle](/business/nouns/handle) | Yes | One page of Handles. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Handle",
  "handles": [
    {
      "$id": "https://api.sb/leaseline.app/handles/handle_FcnNwYQujc",
      "$type": "Handle",
      "venue": "Example venue",
      "name": "Leaseline"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "handle_FcnNwYQujc"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/handles?limit=20",
    "next": "https://api.sb/leaseline.app/handles?after=handle_FcnNwYQujc"
  }
}
```