> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bead.run/llms.txt
> Use this file to discover all available pages before exploring further.

# List default templates

> List available default templates with their latest build and resource details.

## Authentication

Send your scoped bearer token in the `Authorization: Bearer <BEAD_TOKEN>` header, or send your API key in `X-API-Key`.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark-default"}}
curl --request GET \
  --url "https://api.bead.run/default-templates" \
  --header "X-API-Key: $BEAD_API_KEY"
```

## Response

### 200

Successfully returned the default templates.

**response** `object[]`

Successfully returned the default templates.

**Properties**

**aliases** `string[]` *required* *deprecated*

Aliases of the template

**buildCount** `integer` *required*

Number of times the template was built Format: `int32`.

**buildID** `string` *required*

Identifier of the last successful build for given template

**buildStatus** `string` *required*

Status of the template build Allowed values: `"building"`, `"waiting"`, `"ready"`, `"error"`.

**cpuCount** `integer` *required*

CPU cores for the sandbox Format: `int32`. Minimum: `1`.

**createdAt** `string` *required*

Time when the template was created Format: `date-time`.

**createdBy** `object | null` *required*

Creator metadata visible only when you can inspect template usage. May be `null`.

**Properties**

**email** `string | null` *required* *deprecated* (default: null)

Email of the user May be `null`.

**id** `string` *required*

Identifier of the user Format: `uuid`.

**default\_kind** `string`

Default machine lifetime for this template. Allowed values: `"temporary"`, `"persistent"`.

**description** `string`

Description of the template

**diskSizeMB** `integer` *required*

Disk size for the sandbox in MiB Format: `int32`. Minimum: `0`.

**envdVersion** `string` *required*

Version of the envd running in the sandbox

**isDefault** `boolean`

Whether the template is one of the platform's default templates. A default template owned by another team carries zero or null usage fields (`spawnCount`, `buildCount`, `lastSpawnedAt`, `createdBy`).

**lastSpawnedAt** `string | null` *required*

Time when the template was last used Format: `date-time`. May be `null`.

**memoryMB** `integer` *required*

Memory for the sandbox in MiB Format: `int32`. Minimum: `128`.

**names** `string[]` *required*

Names of the template (namespace/alias format when namespaced)

**public** `boolean` *required*

Whether the template is public or only accessible by the team

**spawnCount** `integer` *required*

Number of times the template was used Format: `int64`.

**templateID** `string` *required*

Identifier of the template

**updatedAt** `string` *required*

Time when the template was last updated Format: `date-time`.

## Errors

| Status | Meaning |
| - | - |
| 401 | Authentication credential is missing or rejected. |
| 403 | The credential lacks the required scope. |
| 429 | Request or resource admission limit exceeded (`admission_limit`). Follow limit.next\_action and Retry-After when present. |
| 503 | Service or persistence is temporarily unavailable. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.