# API Key routes: get, list

URL: /code/api/api-key/records · Id: `page:code/api/api-key/records`

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

Reference for [API Key](/business/nouns/api-key), one group of [API Key routes](/code/api/api-key).

### APIKey.get
Returns one API Key by id. [Verb page](/business/nouns/api-key/get?interface=api).

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `apiKey` | [API Key](/business/nouns/api-key) | Yes | The API Key. |

**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/api-keys/key_BG13nfhe26 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "APIKey",
  "$id": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26",
  "apiKey": {
    "$id": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26",
    "$type": "APIKey",
    "name": "Nightly sync",
    "environment": "test"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26",
    "up": "https://api.sb/ratebook.dev/api-keys"
  },
  "actions": {
    "revoke": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26/revoke",
    "roll": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26/roll"
  }
}
```

### APIKey.list
Returns API Keys, newest first, one page at a time. [Verb page](/business/nouns/api-key/list?interface=api).

```text
GET /{namespace}/api-keys
```

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 |
| --- | --- | --- | --- |
| `apiKeys` | list of [API Key](/business/nouns/api-key) | Yes | One page of API Keys. |

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

```json
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "APIKey",
  "apiKeys": [
    {
      "$id": "https://api.sb/ratebook.dev/api-keys/key_BG13nfhe26",
      "$type": "APIKey",
      "name": "Nightly sync",
      "environment": "test"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "key_BG13nfhe26"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/api-keys?limit=20",
    "next": "https://api.sb/ratebook.dev/api-keys?after=key_BG13nfhe26"
  }
}
```