---
title: "Get data to create a contract"
method: GET
path: "/helpers/contract_create_data"
tags: ["Helpers"]
---

# Get data to create a contract

`GET /helpers/contract_create_data`

Use this endpoint to retrieve the workspaces with their templates. This data is essential for creating a contract.

## Query parameters

- `extension_type` string
- `template_type_id` integer

## Headers

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

## Response `200`

Returns the workspaces with embedded templates for creating a contract.

- object[]
  - `id` integer, required
  - `name` string, required
  - `templates` object[], required
    - `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
    - `configuration` object, nullable — 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.
    - `created_time` string, datetime, required
    - `draft_approval_workflow` object, nullable — Draft approval work flow details.
      - `status` string, nullable
    - `id` integer, required
    - `name` string, required
    - `pending_approval_workflow` object, nullable — Pending approval work flow details.
      - `status` string, nullable
    - `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
  - `updated_time` string, datetime, nullable

## Other responses

- `400` — Invalid format or content of the request.
- `403` — The request is not authorized by the server.

---

[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)