Workspace

In Oneflow, workspaces is a way to organize your account contracts, templates, address books, etc., into relevant categories and control access.

A workspace can represent a sales, human resources, or development department, a subsidiary of a company such as Sweden, Germany, or Norway, or a general link between contracts in that workspace.

Access to the workspace is provided to users directly or through a group. You can also set up access in the Oneflow application user interface.

🚧

Note:

You can manage workspaces only on the Oneflow application user admin pages as an administrator.

Workspace attributes

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

AttributeTypeDescription
_linksobjectContains links to endpoints associated with the parent object. See Links.
_permissionsobjectContains the current user's permissions for various operations that are possible in the workspace. See Workspace permission.
company_namestringThe default name of the company used in all templates and contracts that belong to this workspace, such as "Test Company".
country_codestring(country_code)The default country code used in all templates and contracts belonging to this workspace.
created_timestring(datetime)The time when the workspace was created.
date_formatstringThe date format used in all templates and contracts that belong to this workspace.
See Date format.
descriptionstringThe description of the workspace, such as "Workspace for sale contracts".
idinteger(signed_integer_id)The ID of the workspace.
namestringA short, descriptive name for the workspace, such as "Hubspot gallery with a shared template."
registration_numberstringThe default registration number of the company used in all templates and contracts that belong to this workspace, such as "11223344-5566".
updated_timestring(datetime)The time when the workspace was last updated.

Permissions

The _permissions object contains permissions for various operations possible within the workspace. The permission format is ''contract:'' followed by a specific operation, such as ''contract:create.''

πŸ“˜

Note:

Permissions are always set for the current user. If the permission is set to true, the user will be able to perform the specified operation; otherwise, the operation will be disabled for the current user.

AttributeTypeDescription
contract:createbooleanIndicates whether the user is allowed to create contracts in a particular workspace.

Date format

The default date format used in all templates and contracts that belong to this workspace.
If date format is set , it should be one of the following values, otherwise it will return empty string:

  • "YYYY-MM-DD"
  • "DD-MM-YYYY"
  • "YYYY/MM/DD"
  • "MM/DD/YYYY"
  • "DD/MM/YYYY"
  • "YYYY.MM.DD"
  • "DD.MM.YYYY"