The contract template is used as a model to create a new contract. Templates are created using the Template editor in the Oneflow app.

🚧
Note:
Templates cannot be created or edited via the API.

Template attributes

The table below contains the list of all the attributes available for each template.

Attribute	Type	Description
_links	object	Contains links to endpoints associated with the parent object. See Links.
available_options	object	Provides information about the capabilities of the contract. See Available options.
configuration	object	The configuration details of the template. See Configuration.
created_time	string(datetime)	The time the template was created.
id	integer(signed_integer_id)	The ID of the template.
name	string or null	A short descriptive name of the template, like "Shoe sales proposal".
parties	array	The list of parties in the contract, representing companies, organizations, individuals, government departments, etc. See Party.
product_groups	array	The list of product groups. See Product group.
template_type	object	The type of template. See Template type.
updated_time	string(datetime)	The time the template was last updated.
workspaces	arry	The list of workspaces to which the template belongs or has been shared, and which the current user has accessed, along with their respective workspace names and IDs.

Configuration

Attribute	Type	Description
default_creator_roles	object	The default creator role of the template. This decides which role the creator will get when a contract is created. This is indicated using a combination of attributes. See Default_creator_roles.

Attribute	Type	Description
_permissions	object	Defines the permission for the default creator role. See Permissions.
organizer	boolean	A flag to indicate the creator is an owner-side internal participant.
signatory	boolean	Indicates if the creator can sign the contract.

📘
Note:
See Combining participant flags and permissions for more details on Roles in the Oneflow application.