# Role methods: create, get, list

URL: /code/sdk/role/records · Id: `page:code/sdk/role/records`

> The Role Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.

Reference for [Role](/business/nouns/role), one group of [Role methods](/code/sdk/role).

### Role.create
Creates a Role. [Verb page](/business/nouns/role/create?interface=sdk).

```ts
interface RoleVerbs {
  create(input: RoleCreateInput, options?: SB.CallOptions): SB.Call<Role>
}
```

Emits `Role.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | The title of the seat. |
| `responsibilities` | `text` | No | The work the seat owns. |
| `approvals` | `json` | No | What waits for the founder: rules by action class (`spend`, `sign`, `publish`, `price`, `send`), each optionally above an amount in USD. |
| `team` | [Team](/business/nouns/team) | No | A Team groups the Roles that do one kind of work under one owner. |

**Returns**

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

**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**

```ts
import { $ } from 'startup-builder'

const role = await $.Role.create({ name: 'Leaseline' })
```

### Role.get
Returns one Role by id. [Verb page](/business/nouns/role/get?interface=sdk).

```ts
interface RoleVerbs {
  get(input: RoleGetInput, options?: SB.CallOptions): SB.Call<Role>
}
```

Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Role. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

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

**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**

```ts
import { $ } from 'startup-builder'

const role = await $.Role.get({ id: 'role_oloMFMUeCH' })
```

### Role.list
Returns Roles, newest first, one page at a time. [Verb page](/business/nouns/role/list?interface=sdk).

```ts
interface RoleVerbs {
  list(input?: RoleListInput, options?: SB.CallOptions): SB.ListCall<Role>
}
```

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 |
| --- | --- | --- | --- |
| `roles` | list of [Role](/business/nouns/role) | Yes | One page of Roles. |

**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**

```ts
import { $ } from 'startup-builder'

const roles = await $.Role.list({ limit: 20 })
```