# List templates

List shared templates and the caller's own templates. A null owner_account_id identifies a shared template.

POST https://api.brigg.app/v1/operations/workspace.ListTemplates

## Access & visibility

Allow `workspace.ListTemplates` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request

No parameters. Send an empty JSON object (`{}`).

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.

Use template_id as the template identity. owner_account_id is null for a shared template and names the owner for a personal template. category and signable do not prove that a template contains an original Word file; Word filling requires a template prepared from a .docx in Brigg.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Document template](#document-template-response-items) | Yes | Document templates available to the acting member. This operation has no cursor pagination. |

### Document template · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `template_id` | string | Yes | Template identifier. |
| `label` | string | Yes | Human-readable template name. |
| `catalog_id` | null or string | Yes | Source template's catalog identifier, or null for a template without a catalog source. |
| `installed_at` | number | Yes | Time the template was installed, in Unix milliseconds. |
| `owner_account_id` | null or string | Yes | Owner of a private template, or null for a workspace template. |
| `category` | string | Yes | Product category used to organize this template in Brigg. |
| `signable` | boolean | Yes | Whether documents made from this template support the signing workflow. Allowed: `false`, `true`. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List document template fields](https://developer.brigg.app/reference/documents/ListDocumentTemplateFields)
- [Fill Word template](https://developer.brigg.app/reference/documents/FillWordTemplate)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/workspace.ListTemplates' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/workspace.ListTemplates", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/workspace.ListTemplates",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "template_id": "template_consulting",
      "label": "Consulting agreement",
      "catalog_id": null,
      "installed_at": 1794301200000,
      "owner_account_id": null,
      "category": "documents",
      "signable": true
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "title": "Document template",
        "type": "object",
        "properties": {
          "template_id": {
            "type": "string",
            "description": "Template identifier.",
            "examples": [
              "template_consulting"
            ]
          },
          "label": {
            "type": "string",
            "description": "Human-readable template name.",
            "examples": [
              "Consulting agreement"
            ]
          },
          "catalog_id": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Source template's catalog identifier, or null for a template without a catalog source.",
            "examples": [
              null
            ]
          },
          "installed_at": {
            "type": "number",
            "description": "Time the template was installed, in Unix milliseconds.",
            "examples": [
              1794301200000
            ]
          },
          "owner_account_id": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Owner of a private template, or null for a workspace template.",
            "examples": [
              null
            ]
          },
          "category": {
            "type": "string",
            "description": "Product category used to organize this template in Brigg.",
            "examples": [
              "documents"
            ]
          },
          "signable": {
            "type": "boolean",
            "enum": [
              false,
              true
            ],
            "description": "Whether documents made from this template support the signing workflow.",
            "examples": [
              true
            ]
          }
        },
        "required": [
          "template_id",
          "label",
          "catalog_id",
          "installed_at",
          "owner_account_id",
          "category",
          "signable"
        ],
        "additionalProperties": false
      },
      "description": "Document templates available to the acting member. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "template_id": "template_consulting",
          "label": "Consulting agreement",
          "catalog_id": null,
          "installed_at": 1794301200000,
          "owner_account_id": null,
          "category": "documents",
          "signable": true
        }
      ]
    }
  ]
}
```