# Product Template routes: create, get, list

URL: /code/api/product-template/records · Id: `page:code/api/product-template/records`

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

Reference for [Product Template](/business/nouns/product-template), one group of [Product Template routes](/code/api/product-template).

### ProductTemplate.create
Creates a Product Template. [Verb page](/business/nouns/product-template/create?interface=api).

```text
POST /{namespace}/product-templates
```

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

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | `string` | Yes | The page path under `/start/templates/products`. |
| `kind` | `string` | Yes | The abstract Product: `data`, `software`, `agent`, or `service`. |
| `supply` | `string` | Yes | Who supplies the work: `digital`, which is unlimited, or `human`, which is recruited and credentialed. |
| `worker` | `string` | Yes | Who does the work: `agents`, `humans`, or `agents-and-humans`. |
| `buyer` | `string` | Yes | Who buys: `human`, `agent`, or `human-or-agent`. |
| `earningModel` | `string` | Yes | How it earns: `subscription`, `usage`, `commerce`, `marketplace`, or `directory`. |
| `assurance` | `text` | No | What the buyer can rely on, in one sentence. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `productTemplate` | [Product Template](/business/nouns/product-template) | Yes | The Product Template. |

**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/product-templates \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"leaseline","kind":"data","supply":"Example supply","worker":"agents","buyer":"human","earningModel":"subscription"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "productTemplate": {
    "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "$type": "ProductTemplate",
    "slug": "leaseline",
    "kind": "data",
    "supply": "Example supply",
    "worker": "agents"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "ProductTemplate.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### ProductTemplate.get
Returns one Product Template by id. [Verb page](/business/nouns/product-template/get?interface=api).

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `productTemplate` | [Product Template](/business/nouns/product-template) | Yes | The Product Template. |

**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/product-templates/ptpl_mLTPhHFQYD \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ProductTemplate",
  "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
  "productTemplate": {
    "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "$type": "ProductTemplate",
    "slug": "leaseline",
    "kind": "data",
    "supply": "Example supply",
    "worker": "agents"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
    "up": "https://api.sb/leaseline.app/product-templates"
  }
}
```

### ProductTemplate.list
Returns Product Templates, newest first, one page at a time. [Verb page](/business/nouns/product-template/list?interface=api).

```text
GET /{namespace}/product-templates
```

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 |
| --- | --- | --- | --- |
| `productTemplates` | list of [Product Template](/business/nouns/product-template) | Yes | One page of Product Templates. |

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

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "ProductTemplate",
  "productTemplates": [
    {
      "$id": "https://api.sb/leaseline.app/product-templates/ptpl_mLTPhHFQYD",
      "$type": "ProductTemplate",
      "slug": "leaseline",
      "kind": "data",
      "supply": "Example supply",
      "worker": "agents"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "ptpl_mLTPhHFQYD"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/product-templates?limit=20",
    "next": "https://api.sb/leaseline.app/product-templates?after=ptpl_mLTPhHFQYD"
  }
}
```