The Instance Entity

`Instance`

Common Properties

These are the most commonly used properties of an Instance.

Name	Type	Description
`id`	`string`	The unique ID of the Instance
`workflowId`	`string`	The unique ID of the Workflow the Instance was started from
`name`	`string`	The descriptive name of the Instance
`description`	`string`	A description of the Instance
`category`	`string`	A descriptive grouping for your Instance
`status`	`InstanceStatus`	`running`, `completed` or `cancelled`
`fields`	`Fields[]`	The fields containing the data for the Instance
`steps`	`InstanceStep[]`	The steps of the Instance

Permission and Visibility Properties

These are the properties that determine how users can find, or update an Instance.

Name	Type	Description
`fieldVisibility`	`FieldVisibility`	The default visibility level of fields for this Workflow `public`, `internal`, `confidential` or `highlyConfidential`
`visibility`	`InstanceVisibility`	The visbility level of the Instance `open` or `restricted`
`visibleToUsers`	`string[]`	The users or groups who who may view this Instance Users will be represented by their `email`, groups by their group name (starting with `g_`).
`createdBy`	`string`	The email address of the user who started the Instance
`owner`	`string`	The email address of the user who is the primary admin for the Instance.

Updated about 4 years ago