---
title: "Get templates"
method: GET
path: "/templates"
tags: ["Templates"]
---

# Get templates

`GET /templates`

Use this endpoint to retrieve the list of templates available for the specified user.

## Query parameters

- `offset` integer
- `limit` integer
- `extension_type` string
- `template_type_id` integer
- `filter[workspace_ids]` string
- `filter[active]` 'true' | 'false' | ''
- `filter[playbook_ids]` string
- `filter[blueprint_ids]` string
- `sort` string

## Headers

- `x-oneflow-api-token` string, required
- `x-oneflow-user-email` string, email

## Response `200`

Returns the list of [template](template)s.

- object — A collection of templates.
  - `_links` object — Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `_links` object — Links to related endpoints.
      - `comments` object
        - `href` string, nullable
      - `contracts` object
        - `href` string, nullable
      - `contract` object
        - `href` string, nullable
      - `create` object
        - `href` string, nullable
      - `data_field` object
        - `href` string, nullable
      - `data_fields` object
        - `href` string, nullable
      - `events` object
        - `href` string, nullable
      - `event` object
        - `href` string, nullable
      - `files` object
        - `href` string, nullable
      - `file` object
        - `href` string, nullable
      - `next` object
        - `href` string, nullable
      - `parties` object
        - `href` string, nullable
      - `party` object
        - `href` string, nullable
      - `previous` object
        - `href` string, nullable
      - `publish` object
        - `href` string, nullable
      - `self` object
        - `href` string, nullable
      - `template_types` object
        - `href` string, nullable
      - `template_type` object
        - `href` string, nullable
      - `template` object
        - `href` string, nullable
      - `templates` object
        - `href` string, nullable
      - `workspaces` object
        - `href` string, nullable
      - `workspace` object
        - `href` string, nullable
      - `playbooks` object
        - `href` string, nullable
    - `_private` object — See [Private](https://developer.oneflow.com/docs/contract#private)
      - `date_format` string, required — The date format of the template.
      - `language` string — The language of the template.
      - `name` string, required — The name of the template.
      - `signing_period_expiration` union, required
        - object — The signing period for this contract never expires
          - `type` 'never', required — Can only be 'never'.
        - object — The signing period for this contract expires a given number of days after publishing. This setting can only be used when the contract is in the draft stage. Converts into a "fixed_date" after the contract is published.
          - `type` 'days_after_publish', required — Can only be 'days_after_publish'.
          - `expire_days_after_publish` integer, required
        - object — The signing period for this contract expires on a set date.
          - `type` 'fixed_date', required — Can only be 'fixed_date'.
          - `expire_date` string, date, required
      - `workspace_id` integer, nullable, required — The unique id of this workspace.
      - `single_sign` boolean — State of the feature single sign
    - `available_options` object, required — Available options in the contract. See [Available options](https://developer.oneflow.com/docs/contract#available-options).
      - `can_receive_attachments` boolean, required
      - `can_receive_expanded_pdf` boolean, required
      - `can_receive_products` boolean, required
      - `can_receive_product_tax` boolean, required
      - `delivery_channels` object[], required
        - `name` 'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown', required — One of the contract [delivery channels](contract#delivery-channels).
        - `preferred` boolean, required
        - `required_participant_attributes` string[], required
      - `sign_methods` object[], required
        - `name` 'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign' | 'unknown', required — One of the [sign methods](contract#sign-methods).
        - `preferred` boolean, required
      - `two_step_authentication_methods` object[], required
        - `name` 'email' | 'sms' | 'personal_identification' | 'none' | 'unknown', required — One of the [two step authentication methods](contract#two-step-authentication-methods).
        - `preferred` boolean, required
        - `required_participant_attributes` string[], required
    - `created_time` string, datetime, required
    - `configuration` object, nullable, required — Default configuration details of a template
      - `default_creator_roles` object, required — Roles of a default contract creator who creates contracts using a specific template.
        - `_permissions` object, required — This attribute contains the permissions for the participant/creator on the contract.
          - `contract:update` boolean, required
        - `organizer` boolean, required — A flag to indicate that the default contract creator functions as an organizer.
        - `signatory` boolean, required — A flag to indicate that the default contract creator functions as a signatory.
      - `default_counterparty_type` 'company' | 'individual' — Default counterpaty type in the template.
    - `draft_approval_workflow` object, nullable — Draft approval work flow details.
      - `status` string, nullable
    - `id` integer, required
    - `name` string, required
    - `playbook` object, nullable — The playbook used by the template.
      - `id` integer, required
      - `name` string, required
    - `blueprints` object[], nullable
      - `id` integer, required
      - `name` string, required
    - `pending_approval_workflow` object, nullable — Pending approval work flow details.
      - `status` string, nullable
    - `source_contract_id` integer
    - `tags` object[], required — All tags associated with the template.
      - `id` integer, required
      - `name` string, required
    - `template_active` boolean
    - `template_type` object, nullable, required — An optional type for the template meaning it supports a specific set of template variables. See [Template type](https://developer.oneflow.com/docs/template-type).
      - `_links` object — Links to related endpoints.
        - `comments` object
          - `href` string, nullable
        - `contracts` object
          - `href` string, nullable
        - `contract` object
          - `href` string, nullable
        - `create` object
          - `href` string, nullable
        - `data_field` object
          - `href` string, nullable
        - `data_fields` object
          - `href` string, nullable
        - `events` object
          - `href` string, nullable
        - `event` object
          - `href` string, nullable
        - `files` object
          - `href` string, nullable
        - `file` object
          - `href` string, nullable
        - `next` object
          - `href` string, nullable
        - `parties` object
          - `href` string, nullable
        - `party` object
          - `href` string, nullable
        - `previous` object
          - `href` string, nullable
        - `publish` object
          - `href` string, nullable
        - `self` object
          - `href` string, nullable
        - `template_types` object
          - `href` string, nullable
        - `template_type` object
          - `href` string, nullable
        - `template` object
          - `href` string, nullable
        - `templates` object
          - `href` string, nullable
        - `workspaces` object
          - `href` string, nullable
        - `workspace` object
          - `href` string, nullable
        - `playbooks` object
          - `href` string, nullable
      - `created_time` string, datetime, nullable, required
      - `description` string, required
      - `extension_type` string, nullable, required
      - `id` integer, required
      - `name` string, required
      - `updated_time` string, datetime, nullable, required
    - `updated_time` string, datetime, nullable, required
    - `workspaces` object[], required — All workspaces associated with the template.
      - `id` integer, required
      - `name` string, nullable, required

## Other responses

- `400` — Invalid format or content of the request.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)